概要 - インプレッション
API + MCPこのエンドポイントへのリクエストは、
promptsパラメータに基づいてAPIユニットを消費します。カスタムプロンプトのデータのみを返すリクエストは無料ですが、Ahrefsのプロンプトデータを含むリクエストはスタンダードのAPIユニット料金が適用されます。
クエリパラメータ
フィルター式。次の列識別子が認識されます(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_source に chatgpt または perplexity が含まれていない場合、このフィールドは常に空になります。
type: string
topic: クエリのトピック。
type: string
返すカラムのカンマ区切りリストです。有効なカラム識別子はレスポンスのスキーマを参照してください。
2文字の国コード(ISO 3166-1 alpha-2)をカンマ区切りで指定したリスト。
使用するレポートの ID。指定した場合、他のパラメータ(ブランド、競合、マーケット、国、フィルター)はレポートから取得されます。国またはフィルターが指定されている場合は、レポート内の設定よりも優先されます。Ahrefs のブランドレーダー レポートの URL(https://app.ahrefs.com/brand-radar/reports/#report_id#/...)で確認できます。
使用するプロンプトの種類。指定がない場合は両方が使用されます。カスタムプロンプトを使用するには report_id の指定が必要です。
チャットボットモデルのカンマ区切りリスト。Google モデル(google_ai_overviews、google_ai_mode)は、互いに組み合わせることも、Google 以外のモデルと組み合わせることもできません。
ブランドのニッチ市場のカンマ区切りリスト。
ブランドの競合のカンマ区切りリスト。
検索対象のブランドのカンマ区切りリスト。brand、competitors、market、where のうち少なくとも 1 つは空にしないでください。
出力形式。
応答
ブランド名(自社ブランド、またはリクエストで指定された競合ブランド)。
指定した市場に関連する応答のうち、提供されたブランドがいずれも言及されていないものからの推定インプレッション数(market が指定されていない場合、値は0)。
競合ブランドのみが言及されている応答からの推定インプレッション数。
自社ブランドのみが言及されている応答からの推定インプレッション数。
自社ブランドと競合ブランドの両方が言及されている応答からの推定インプレッション数。
自社ブランドの推定インプレッション合計(only_target_brand と target_and_competitors_brands を含む)。