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

概要 - メンション

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

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

brands(該当する場合は competitors も)で指定する各エンティティには、names に少なくとも1つの値を含める必要があります。メンションはブランド名と照合されるため、url_groups のみで構成されるエンティティはここではサポートされていません。

リクエスト本文

whereobject

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

selectarray<string>Required

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

Example:["field_a","field_b"]
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
Default:
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_overviews_keywordsgoogle_ai_mode_keywords)は、互いに、または他のモデルと組み合わせて使用できません。

Allowed values:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotgrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords
marketarray<string>

ブランドのニッチ市場のリストです。2026-05-18に非推奨となり、この日付以降まもなくこのパラメータは効果がなくなります。

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

ターゲットのスコープ。

Allowed values:urlpathdomainsubdomains
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

ターゲットのスコープ。

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 を含む)。