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

AI の応答

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

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

クエリパラメータ

selectstring必須

返却するフィールドのカンマ区切りリストです。

wherestring

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

report_idstring

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

brandstring

検索するブランドをカンマ区切りで指定します。brand、competitors、market、where のうち、少なくとも1つは空でない必要があります。

competitorsstring

ブランドの競合をカンマ区切りで指定します。

data_sourcestring必須

チャットボットモデルのカンマ区切りリスト。すべてのモデルは組み合わせて使用できます。claude モジュールはカスタムプロンプトのみをサポートします。
google_ai_overviews_keywords および google_ai_mode_keywords モデルは、プロンプトではなく Google 検索クエリ(キーワード)から導出した AIによる概要/AI モードの可視性をレポートします。

許可される値:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotclaudegrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords
Example:chatgpt,perplexity
countrystring

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

許可される値:adaeafagaialamaoarasatauawazba…
promptsstring

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

許可される値:ahrefscustom
limitinteger

返す結果の数です。

デフォルト:1000
datestring (date)

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

date_comparedstring (date)

date と比較する日付(YYYY-MM-DD 形式)。date より厳密に前の日付である必要があります。設定すると、レポートにはいずれかの日付で回答されたすべてのプロンプトが含まれ、status フィールドにはそれぞれが両日間でどのように変化したかが表示されます。date_compared のみに回答があるプロンプトは lost としてレポートされ、それ以外のフィールドには date に回答が存在しないため date_compared のレスポンスが記述されます。

order_bystring

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

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

出力形式。

許可される値:jsonphp

応答

ai_responsesarray<object>
brand_sentimentarray<object>

回答内にある追跡中ブランドのすべてのメンション(自社ブランドを先に、その後に競合を指定順で)と、それについて回答がどのように述べているか。

brandstring

言及されている追跡中のブランド。

sentimentstring or null

このメンションで、回答がブランドについてどのように述べているか。利用できない場合は null です。

許可される値:positiveneutralnegativemixednull
aspectstring or null

価格や品質など、このメンションが何についてのものか。利用できない場合は null です。

許可される値:features_specsperformance_effectivenessprice_valuereputation_popularityquality_reliabilitydesign_comfortusability_compatibilityavailability_deliverysafety_healthservice_supportgeneralnull
snippetstring or null

メンションの前後の文。回答内で見つけられない場合は null です。

countrystring

質問の国。

data_sourcestring

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

funnel_stagestring or null

プロンプトのファネルステージ。ファネルステージが利用できない場合は null になります。

許可される値:awarenessconsiderationdecisionunclearnull
intentarray<string>

プロンプトの意図ラベル(主な意図、サブタイプ、ブランド/ローカル属性など)です。空の配列は、利用可能な意図ラベルがないことを意味します。

許可される値:informationalnavigationaltransactionalbrandedcommercialcomparisonhow_tolocalopinionrecommendation
last_updatedstring (date)

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

linksarray<object>

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

urlstring
titlestring or null
questionstring

ユーザーが尋ねた質問。

responsestring

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

search_queriesarray<string>

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

statusstring or null

date_compared と date の間でプロンプトがどのように変化したか。date_compared が設定されていない場合は null です。new — date では回答されたが date_compared では回答されなかった。lost — date_compared では回答されたが date では回答されなかった。date には回答がないため、この行の残りは date_compared の応答内容を示します。no_change — 両日とも回答された。これは応答自体、言及、引用が変化したかどうかについては何も示しません。

許可される値:newlostno_changenull
tagsarray<string>

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

volumeinteger

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