Skip to main content
POST
AI の回答がどのドメインやページを引用しているかを、引用数の多い順にランク付けして表示します。URL レベルの行を取得するには page でグループ化します。自社が所有するドメインのみを表示するには scope: "owned" を使用します。
  • 指標: count (引用の生の件数)、citation_share (モデルごとの平均シェア)、rank、first_cited_at (ページのみ)。
  • group_by: page、date、model、topic、region、persona、prompt。
  • sort なし: 行は常に引用数の多い順に並びます。
  • 引用レイヤーのフィルタ: domain (サブドメインを考慮)、page、analysis_type (visibility·sentiment·factcheck·all)、citation_category (owned·competition·social·earned_media·earned_institutions·pr_wire·other·カスタム)、citation_tag (カスタムタグ。Get Citation Tags で一覧を取得できます)。
citation_category と citation_tag はどちらもトップレベルの and リーフで、 is / in を受け付けます。1 つの in 内の値は OR で結合されるため、 {"field": "citation_tag", "op": "in", "value": ["Editorial", "Docs"]} はいずれかのタグを持つ URL に一致します。
count と citation_share は異なるものを測定します。citation_share は AI モデルごとに平均されるため、生の count と同じ順序で並ぶとは限りません。
v2 レポートを初めて使用する場合は、共通のリクエスト形式、フィルタツリー、グループ化、ページネーションについて フィルタリングと概念 を参照してください。
POST /v2/reports/citations/stream は 同じリクエストボディ を受け取り、 Server-Sent Events を返します。 まず 1 つの summary イベント (info ブロック) が送信され、続いて行ごとに 1 つの result イベントが送信されます。 limit/cursor は無視され、デフォルトではすべての結果が返されます。上限を設けるには max_results を指定します。
Response (text/event-stream)

承認

X-API-Key
string
header
必須

ボディ

application/json
category_id
string<uuid>
必須
start_date
string
必須

YYYY-MM-DD, ET, inclusive

end_date
string
必須

YYYY-MM-DD, ET, inclusive

entity
enum<string>
デフォルト:domain

What each row represents: domain (default), page, or citation_category. Legacy: group_by: ["page"] (with entity omitted) is still accepted and is equivalent to entity: "page". citation_category uses the dashboard split view: a citation counts under both its page-level and domain-level category, so category shares can sum to more than 100%.

利用可能なオプション:
domain,
page,
citation_category
group_by
enum<string>[]
利用可能なオプション:
page,
date,
model,
topic,
region,
persona,
prompt
metrics
enum<string>[] | null
利用可能なオプション:
count,
citation_share,
rank,
first_cited_at
interval
enum<string>
デフォルト:day
利用可能なオプション:
day,
week,
month
scope
enum<string>
デフォルト:all

all (every cited domain) or owned (only your owned domains). Applies to entity=domain.

利用可能なオプション:
all,
owned
filter
FilterNode · object | null

citation_category filters on a cited URL's single category; citation_tag filters on the custom citation tags a URL carries (a URL can carry several). List the category's tags with GET /v1/org/categories/{category_id}/citation-tags.

limit
integer | null

Page size; default 10, max 50.

必須範囲: 0 < x <= 50
max_results
integer | null

Stream endpoint only: cap the number of streamed rows (default: all).

必須範囲: x > 0
cursor
string | null

レスポンス

Successful Response

info
CitationsV2Info · object
必須
data
CitationRow · object[]
必須