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

インプレッション

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

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

リクエスト本文

selectarray<string>Required

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

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

Optional phrases used to include or exclude results based on their content.

includearray<string>

Only show results containing at least one of these exact phrases.

excludearray<string>

Hide results containing any of these exact phrases.

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
search_volume_typestring

AI 可視性レポートは AI 調整後ボリュームへ移行しています。これにより、チャットボットや AI 検索サーフェス全体における AI レスポンスの需要をより適切に推定できます。Google と比較した各 AI プラットフォームの推定利用状況に基づき、Google の検索ボリュームを調整して算出します。このパラメータは 2026 年 9 月 30 日に非推奨となり、以降すべてのリクエストで新しい AI 調整後ボリュームが使用されます。

許可される値:ask_volumekeyword_volume
Default:ask_volume
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"]}]}
outputstring

出力形式。

許可される値:jsoncsvxmlphp

応答

metricsarray<object>
brandstring

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

no_tracked_brandsinteger

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

only_competitors_brandsinteger

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

only_target_brandinteger

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

target_and_competitors_brandsinteger

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

totalinteger

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