Topics

API + MCPエンタープライズ限定

POST/v3/brand-radar/topics

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.

リクエスト本文

selectarray<string>Required

A list of fields to return.

利用可能なフィールド:

country
mentions
responses
topic
volume

Example:["field_a","field_b"]

whereobject

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the select parameter).

report_idstring

The ID of the report to use. If one is given, other parameters are taken from the report (brand, competitors, market, country, filters). If country or filters are provided, they override the ones in the report. You can find it in the URL of your Brand Radar report in Ahrefs: https://app.ahrefs.com/brand-radar/reports/#report_id#/...

brandsarray<object>

A list of brand names and websites to search for.

Default:[]

At least one of names or url_groups is required

namesarray<string>

The names of the brand/competitor

Example:["ahrefs","ahrefs seo"]

url_groupsarray<object>

targetstring (domain)required

The domain of the target

Example:ahrefs.com

scopestringrequired

Scope of the target.

許可される値:urlpathdomainsubdomains

competitorsarray<object>

A list of competitor names and websites to search for.

Default:[]

At least one of names or url_groups is required

namesarray<string>

The names of the brand/competitor

Example:["ahrefs","ahrefs seo"]

url_groupsarray<object>

targetstring (domain)required

The domain of the target

Example:ahrefs.com

scopestringrequired

Scope of the target.

許可される値: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

A list of chatbot models. All models can be combined with each other. claude module supports only custom prompts.
The google_ai_overviews_keywords and google_ai_mode_keywords models report AI Overviews / AI Mode visibility derived from Google search queries (keywords) rather than prompts.

許可される値:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotclaudegrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords

countryarray<string>

A list of two-letter country codes (ISO 3166-1 alpha-2).

許可される値:adaeafagaialamaoarasatauawazba…

Default:[]

promptsstring

The type of prompts to use. If not specified, both will be used. Custom prompts require a report_id to be provided.

許可される値:ahrefscustom

limitinteger

The number of results to return.

Default:1000

datestring (date)

The date to search for in YYYY-MM-DD format.

date_fromstring (date)

The start date of the historical period in YYYY-MM-DD format.

date_tostring (date)

The end date of the historical period in YYYY-MM-DD format.

tags_filterobject

A filter expression for prompt tags. Requires report_id. Uses filter syntax with the following restrictions: the only valid field name is "tag"; the only valid operator are: "eq", "neq", "substring", "isubstring", "phrase_match", "iphrase_match", "prefix", "suffix", "empty"; maximum nesting depth of and, or is 2.

Example:{"or":[{"field":"tag","is":["eq","branded"]},{"field":"tag","is":["eq","competitor"]}]}

brand_filterobject

A filter expression for your brand's visibility, mirroring the "Your brand" filter. brand_name matches whether a response mentions your brand: "mentioned" or "not_mentioned". page_status matches how the AI used your pages: "cited" (the AI retrieved pages from your site and referenced them in the answer), "found_but_not_cited" (the AI retrieved pages from your site as potential sources but did not reference them in the final answer), or "not_found" (the AI did not retrieve any pages from your site).
Uses filter syntax with the following restrictions: the only valid operator is "eq"; each field is one section: give a single value, or combine several values of the same field with or; join the brand_name and page_status sections with a top-level and/or. Selecting every value of a field is rejected, since it matches everything (omit the field instead).

Example:{"and":[{"field":"brand_name","is":["eq","mentioned"]},{"or":[{"field":"page_status","is":["eq","cited"]},{"field":"page_status","is":["eq","found_but_not_cited"]}]}]}

volume_rangeobject

The volume range to filter by.

frominteger

tointeger

outputstring

The output format.

許可される値:jsonphp

応答

topicsarray<object>

countrystring

The country associated with the topic. When no parent topic was identified, this is the only selected country, or all if multiple or all countries were selected.

mentionsarray<object>

Response counts for the tracked brand and each competitor.

entitystring

The tracked brand or competitor.

responsesinteger

The number of AI responses that mention the entity.

responsesinteger

The number of AI responses associated with the topic.

topicstring or null

The parent topic. Null when no parent topic was identified.

volumeinteger or null

The topic's estimated monthly search volume.

curl "https://api.ahrefs.com/v3/brand-radar/topics" \ -X POST \ -H "Authorization: Bearer $AHREFS_API_KEY" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ --data-raw '{ "select": ["field_a","field_b"], "where": {}, "report_id": "string", "brands": [ { "names": ["ahrefs","ahrefs seo"], "url_groups": [ { "target": "ahrefs.com", "scope": "url" } ] } ], "competitors": [ { "names": ["ahrefs","ahrefs seo"], "url_groups": [ { "target": "ahrefs.com", "scope": "url" } ] } ], "content_filter": { "include": ["string"], "exclude": ["string"] }, "data_source": ["chatgpt"], "country": ["ad"], "prompts": "ahrefs", "limit": 0, "date": "string", "date_from": "string", "date_to": "string", "tags_filter": {"or":[{"field":"tag","is":["eq","branded"]},{"field":"tag","is":["eq","competitor"]}]}, "brand_filter": {"and":[{"field":"brand_name","is":["eq","mentioned"]},{"or":[{"field":"page_status","is":["eq","cited"]},{"field":"page_status","is":["eq","found_but_not_cited"]}]}]}, "volume_range": { "from": 0, "to": 0 }, "output": "json" }'

{ "topics": [ { "country": "string", "mentions": [ { "entity": "string", "responses": 0 } ], "responses": 0, "topic": "string", "volume": 0 } ] }