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

AI の応答

API + MCP
POST/v3/brand-radar/ai-responses

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

リクエスト本文

volume_rangeobject

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

frominteger
tointeger
selectarray<string>Required

返すフィールドのリストです。利用可能なフィールド: questionresponsevolumecountrylinkssearch_queriestagsdata_sourcelast_updated

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

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

cited_domain: 応答の生成に使用されたページのドメイン。
型: domain

cited_domain_subdomains: 応答の生成に使用されたページのドメイン。指定したドメインのサブドメインも一致します。
型: string

cited_url_exact: 応答の生成に使用されたページのURL。
型: string

cited_url_prefix: 応答の生成に使用されたページのURL。指定したプレフィックスで始まるURLが一致します。
型: string

question: ユーザーが行った質問。
型: string

response(10ユニット): モデルからの応答。
型: string

search_queries: 応答のための情報を見つける際にチャットボットが使用した検索クエリ。注: data_sourcechatgpt または perplexity が含まれていない場合、このフィールドは常に空になります。
型: string

topic: クエリのトピック。
型: string

tags_filterobject

プロンプトタグ用のフィルター式です。report_id が必要です。フィルター構文を使用しますが、次の制限があります。有効なフィールド名は "tag" のみです。有効な演算子は "eq""neq""substring""isubstring""phrase_match""iphrase_match""prefix""suffix""empty" のみです。andor の最大ネスト深度は 2 です。例: {"or": [{"field": "tag", "is": ["eq", "branded"]}, {"field": "tag", "is": ["eq", "competitor"]}]}

limitinteger

返す結果数です。

Default:1000
datestring (date)

検索対象の日付(YYYY-MM-DD 形式)。

countryarray<string>

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

Allowed values:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw
Default:
order_bystring

結果の並び替えに使用する列。

Allowed values:relevancevolume
Default:relevance
report_idstring

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

promptsstring

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

Allowed values:ahrefscustom
data_sourcearray<string>Required

チャットボットモデルのリスト。Googleのキーワードモデル(google_ai_overviews_keywordsgoogle_ai_mode_keywords)は、互いに、または他のモデルと組み合わせて使用できません。

Allowed values:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotgrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords
marketarray<string>

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

competitorsarray<object>

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

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

ターゲットのスコープ。

Allowed values:urlpathdomainsubdomains
brandsarray<object>

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

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

ターゲットのスコープ。

Allowed values:urlpathdomainsubdomains
outputstring

出力形式。

Allowed values:jsonphp

応答

ai_responsesarray<object>
countrystring

質問の国。

data_sourcestring

回答を生成したチャットボットモデル。

last_updatedstring (date)

データが最後に更新された日付。

linksarray<object>

(10ユニット)回答に使用されたリンク。

urlstring
titlestring or null
questionstring

ユーザーが尋ねた質問。

responsestring

(10単位) モデルからの応答。

search_queriesarray<string>

チャットボットが応答のための情報を探す際に使用した検索クエリ。注:data_sourcechatgpt または perplexity が含まれない場合、このフィールドは常に空になります。

tagsarray<string>

クエリに付与されたタグ。

volumeinteger

(10単位) 推定月間検索数(検索ボリューム)。Google に関する当社推定に基づき、この質問が People Also Ask セクションに表示される関連キーワードの検索ボリュームを合算して算出しています。