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

AI の応答

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

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

クエリパラメータ

wherestring

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

cited_domain: レスポンス生成に使用されたページのドメイン。
type: domain

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

cited_url_exact: レスポンス生成に使用されたページの URL。
type: string

cited_url_prefix: レスポンス生成に使用されたページの URL。このプレフィックスで始まる URL は一致します。
type: string

question: ユーザーが質問した内容。
type: string

response(10 units): モデルからのレスポンス。
type: string

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

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

selectstring必須

返すカラムのカンマ区切りリストです。有効なカラム識別子はレスポンスのスキーマを参照してください。

limitinteger

返す結果数です。

デフォルト:1000
datestring

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

countrystring

2文字の国コード(ISO 3166-1 alpha-2)をカンマ区切りで指定したリスト。

許可される値:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw
order_bystring

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

許可される値:relevancevolume
デフォルト:relevance
report_idstring

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

promptsstring

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

許可される値:ahrefscustom
data_sourcestring必須

チャットボットモデルのカンマ区切りリスト。Google モデル(google_ai_overviewsgoogle_ai_mode)は、互いに組み合わせることも、Google 以外のモデルと組み合わせることもできません。

許可される値:google_ai_overviewsgoogle_ai_modechatgptgeminiperplexitycopilotgrok
Example:chatgpt,perplexity
marketstring

ブランドのニッチ市場のカンマ区切りリスト。

competitorsstring

ブランドの競合のカンマ区切りリスト。

brandstring

検索対象のブランドのカンマ区切りリスト。brand、competitors、market、where のうち少なくとも 1 つは空にしないでください。

outputstring

出力形式。

許可される値:jsonphp

応答

ai_responsesarray<object>
countrystring

質問の国。

data_sourcestring

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

linksarray<object>

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

questionstring

ユーザーが尋ねた質問。

responsestring

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

search_queriesarray<string>

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

tagsarray<string>

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

volumeinteger

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