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

引用の概要

API のみ
POST/v3/brand-radar/citations-overview

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

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

リクエスト本文

whereobject

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

selectarray<string>Required

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

Example:["field_a","field_b"]
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"]}]}
search_volume_typestring

AI可視性レポートは、AI調整済みボリュームへ切り替わります。これは、チャットボットやAI検索サービス全体におけるAI回答の需要をより正確に推定する指標です。Googleの検索ボリュームを、Googleと比較した各AIプラットフォームの推定利用状況に応じて調整することで算出されます。このパラメータは2026年8月31日に非推奨となり、以降はすべてのリクエストで新しいAI調整済みボリュームが使用されます。

許可される値:ask_volumekeyword_volume
Default:ask_volume
countryarray<string>

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

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

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

promptsstring

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

許可される値:ahrefscustom
data_sourcearray<string>Required

チャットボットモデルのリストです。すべてのモデルは互いに組み合わせて使用できます。claudeモジュールはカスタムプロンプトにのみ対応しています。

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

ブランドのニッチ市場のリストです。2026-05-18に非推奨となり、この日付以降まもなくこのパラメータは効果がなくなります。

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
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
outputstring

出力形式。

許可される値:jsoncsvxmlphp

応答

metricsarray<object>
brandstring

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

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 の両方を含む）。