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

トピック

API + MCPエンタープライズ限定
POST/v3/brand-radar/topics

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

リクエスト本文

selectarray<string>Required

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

利用可能なフィールド:
  • country
  • mentions
  • responses
  • topic
  • volume
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
limitinteger

返す結果の数です。

Default:1000
datestring (date)

検索対象の日付（YYYY-MM-DD 形式）。

date_fromstring (date)

履歴期間の開始日（YYYY-MM-DD形式）。

date_tostring (date)

履歴期間の終了日（YYYY-MM-DD形式）。

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"]}]}
brand_filterobject

「あなたのブランド」フィルターを反映した、ブランドの可視性に関するフィルター式です。brand_name は、回答内でブランドに言及されているかどうか（"mentioned" または "not_mentioned"）に一致します。page_status は、AI があなたのページをどのように使用したか（"cited"（AI があなたのサイトのページを取得し、回答内で参照した）、"found_but_not_cited"（AI があなたのサイトのページを候補ソースとして取得したが、最終回答では参照しなかった）、"not_found"（AI があなたのサイトのページを一切取得しなかった））に一致します。
次の制約のもとで フィルター構文 を使用します。有効な演算子は "eq" のみです。各フィールドを1つのセクションとして扱います。単一の値を指定するか、同じフィールドの複数の値を or で組み合わせてください。brand_name セクションと page_status セクションは、トップレベルの and/or で結合してください。フィールドのすべての値を選択すると、すべてに一致してしまうため拒否されます。代わりに、そのフィールドを省略してください。

Example:{"and":[{"field":"brand_name","is":["eq","mentioned"]},{"or":[{"field":"page_status","is":["eq","cited"]},{"field":"page_status","is":["eq","found_but_not_cited"]}]}]}
volume_rangeobject

フィルタリングに使用するボリューム範囲。

frominteger
tointeger
outputstring

出力形式。

許可される値:jsonphp

応答

topicsarray<object>
countrystring

トピックに紐づく国。親トピックが特定されなかった場合は、これが唯一選択された国となり、複数またはすべての国が選択されている場合は all になります。

mentionsarray<object>

追跡対象ブランドと各競合の回答数。

entitystring

追跡対象のブランドまたは競合。

responsesinteger

エンティティに言及している AI 回答の数。

responsesinteger

トピックに関連付けられている AI 回答の数。

topicstring or null

親トピック。親トピックが特定されなかった場合は null になります。

volumeinteger or null

トピックの推定月間検索ボリューム。