Docs
ドキュメントを検索...⌘K

引用

API + MCP
POST/v3/brand-radar/citations-overview

このエンドポイントへのリクエストでは、prompts パラメータに基づいて API ユニットが消費されます。カスタムプロンプトのデータのみを返すリクエストは無料ですが、Ahrefs のプロンプトデータを含むリクエストには、スタンダードの API ユニット料金が適用されます。

brands（該当する場合は competitors も）で指定される各エンティティには、url_groups に少なくとも 1 つの値を含める必要があります。引用は URL グループと照合されるため、names のみで構成されるエンティティはここではサポートされません。

リクエスト本文

selectarray<string>Required

返すフィールドのリスト。

Example:["field_a","field_b"]
whereobject

フィルター式。次の列識別子が認識されます（select パラメータで認識される識別子とは異なります）。

report_idstring

使用するレポートのIDです。指定した場合、他のパラメータ（ブランド、競合、マーケット、国、フィルター）はレポートから取得されます。country または filters を指定すると、レポート内の設定よりも優先されます。Ahrefs のブランドレーダーのレポートURLで確認できます: https://app.ahrefs.com/brand-radar/reports/#report_id#/...

brandsarray<object>

検索対象のブランド名および Web サイトのリスト。

Default:[]
At least one of names or url_groups is required
namesarray<string>

ブランド／競合他社の名称

Example:["ahrefs","ahrefs seo"]
url_groupsarray<object>
targetstring (domain)required

ターゲットのドメイン

Example:ahrefs.com
scopestringrequired

ターゲットのスコープ。

許可される値:urlpathdomainsubdomains
competitorsarray<object>

検索対象の競合名および Web サイトのリスト。

Default:[]
At least one of names or url_groups is required
namesarray<string>

ブランド／競合他社の名称

Example:["ahrefs","ahrefs seo"]
url_groupsarray<object>
targetstring (domain)required

ターゲットのドメイン

Example:ahrefs.com
scopestringrequired

ターゲットのスコープ。

許可される値:urlpathdomainsubdomains
content_filterobject

内容に基づいて結果を含めたり除外したりするために使用する任意のフレーズ。

includearray<string>

これらの完全一致フレーズのうち、少なくとも1つを含む結果のみを表示します。

excludearray<string>

これらの完全一致フレーズのいずれかを含む結果を非表示にします。

data_sourcearray<string>Required

チャットボットモデルのリスト。すべてのモデルを相互に組み合わせて使用できます。claude モジュールはカスタムプロンプトのみに対応しています。
google_ai_overviews_keywords と google_ai_mode_keywords の各モデルは、プロンプトではなく Google 検索クエリ（キーワード）に基づく、AIによる概要 / AI モードでの表示状況をレポートします。

許可される値:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotclaudegrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords
countryarray<string>

2 文字の国コード（ISO 3166-1 alpha-2）のリスト。

許可される値:adaeafagaialamaoarasatauawazba…
Default:[]
promptsstring

使用するプロンプトの種類。指定されていない場合は両方が使用されます。カスタムプロンプトを使用するには report_id を指定する必要があります。

許可される値:ahrefscustom
tags_filterobject

プロンプトタグ用のフィルター式です。report_id が必要です。次の制約のもとで フィルター構文 を使用します。有効なフィールド名は "tag" のみです。有効な演算子は "eq"、"neq"、"substring"、"isubstring"、"phrase_match"、"iphrase_match"、"prefix"、"suffix"、"empty" のみです。and、or の最大ネストの深さは2です。

Example:{ "or": [ { "field": "tag", "is": [ "eq", "branded" ] }, { "field": "tag", "is": [ "eq", "competitor" ] } ] }
outputstring

出力形式。

許可される値:jsoncsvxmlphp

応答

metricsarray<object>
brandstring

ブランド名（自社ブランド、またはリクエストで指定された競合ブランド）。

entity_typestring

この行が集計値、あなたのターゲットブランド、または競合を表すかどうか。

許可される値:aggregatetargetcompetitor
no_tracked_brandsinteger

指定した市場に関連する回答のうち、提供されたブランド URL に一切言及していない回答に基づく推定引用数（market が指定されていない場合、値は 0 になります）。

only_competitors_brandsinteger

競合他社のブランド URL のみに言及している回答に基づく推定引用数。

only_target_brandinteger

自社のブランド URL のみに言及している回答に基づく推定引用数。

target_and_competitors_brandsinteger

自社および競合他社のブランド URL の両方に言及している回答に基づく推定引用数。

totalinteger

自社のブランド URL の推定引用数の合計（only_target_brand と target_and_competitors_brands の両方を含む）。