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

インプレッション

API + MCP
GET/v3/brand-radar/impressions-overview

このエンドポイントへのリクエストは、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
outputstring

出力形式。

許可される値:jsoncsvxmlphp

応答

metricsarray<object>
brandstring

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

entity_typestring

この行が集計値、あなたのターゲットブランド、または競合を表すかどうか。

許可される値:aggregatetargetcompetitor
no_tracked_brandsinteger

指定した市場に関連する応答のうち、提供されたブランドがいずれも言及されていないものからの推定インプレッション数(market が指定されていない場合、値は0)。

only_competitors_brandsinteger

競合ブランドのみが言及されている応答からの推定インプレッション数。

only_target_brandinteger

自社ブランドのみが言及されている応答からの推定インプレッション数。

target_and_competitors_brandsinteger

自社ブランドと競合ブランドの両方が言及されている応答からの推定インプレッション数。

totalinteger

自社ブランドの推定インプレッション合計(only_target_brand と target_and_competitors_brands を含む)。