Docs
搜索文档...⌘K

提及

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

Requests to this endpoint consume API units based on the prompts parameter: requests returning only custom prompt data are free, while requests including Ahrefs prompt data follow standard API unit pricing.

Every entity provided in brands (and competitors, when applicable) must include at least one value in names. Entities consisting only of url_groups are not supported here because mentions are matched against brand names.

请求正文

selectarray<string>Required

要返回的字段列表。

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

过滤表达式。支持以下列标识符（这与 select 参数支持的标识符不同）。

report_idstring

要使用的报告 ID。如果提供该参数，则其他参数将从报告中获取（品牌、竞争对手、市场、国家/地区、筛选条件）。如果提供了国家/地区或筛选条件，它们将覆盖报告中的对应值。你可以在 Ahrefs 的 Brand Radar 报告 URL 中找到它：https://app.ahrefs.com/brand-radar/reports/#report_id#/...

brandsarray<object>

要搜索的品牌名称和网站列表。

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>

要搜索的竞争对手名称和网站列表。

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

可选短语，用于根据内容包含或排除结果。

includearray<string>

仅显示至少包含以下任一完全匹配短语的结果。

excludearray<string>

隐藏包含以下任一完全匹配短语的结果。

data_sourcearray<string>Required

聊天机器人模型列表。所有模型都可相互组合。claude 模块仅支持自定义提示词。
google_ai_overviews_keywords 和 google_ai_mode_keywords 模型报告的是基于 Google 搜索查询（关键词）而非提示词得出的 AI Overview / AI Mode 可见性。

允许的值:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotclaudegrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords
countryarray<string>

两位字母国家/地区代码列表（ISO 3166-1 alpha-2）。

允许的值:adaeafagaialamaoarasatauawazba…
Default:[]
promptsstring

要使用的提示词类型。如果未指定，将同时使用两者。自定义提示词需要提供 report_id。

允许的值:ahrefscustom
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

品牌名称（请求中提供的您的品牌或竞争对手品牌）。

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）。