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

概要 - インプレッション

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

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

リクエスト本文

selectarray<string>Required

返却するカラムのリスト。有効なカラム識別子については、レスポンススキーマを参照してください。

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

フィルター式。次の列識別子が認識されます(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

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"]}]}

countryarray<string>

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

Allowed values:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw
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_overviewsgoogle_ai_mode)は、互いに組み合わせることも、Google 以外のモデルと組み合わせることもできません。

Allowed values:google_ai_overviewsgoogle_ai_modechatgptgeminiperplexitycopilotgrok
marketarray<string>

ブランドのニッチ市場のリスト。

competitorsarray<object>

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

At least one of names or url_groups is required
namesarray<string>

ブランド/競合の名前

Example:["ahrefs","ahrefs seo"]
url_groupsarray<object>
targetstringrequired

ターゲットのドメイン

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>
targetstringrequired

ターゲットのドメイン

Example:ahrefs.com
scopestringrequired

ターゲットのスコープ。

Allowed values:urlpathdomainsubdomains
outputstring

出力形式。

Allowed values:jsoncsvxmlphp

応答

metricsarray<object>
brandstring

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

no_tracked_brandsinteger

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

only_competitors_brandsinteger

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

only_target_brandinteger

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

target_and_competitors_brandsinteger

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

totalinteger

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