Docs
Search docs...⌘K

Brand Radar Reports

API only
POST/v3/management/brand-radar-reports

Requests to this endpoint are free and do not consume any API units.

Query parameters

outputstring

The output format.

Allowed values:jsonphp

Request body

brand

At least one of brand or competitors is required to be non-empty.

Recommended. Can specify brand names and URL groups for precise targeting.

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.

Allowed values:urlpathdomainsubdomains
competitors

At least one of brand or competitors is required to be non-empty.

Recommended. Can specify brand names and URL groups for precise targeting.

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.

Allowed values:urlpathdomainsubdomains
namestring

The name of the report.

project_idinteger

The ID of the project to use.

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.

prompts_frequencyarray<object>

The prompts frequency to use.

Min:1
data_sourcestringrequired

The data source to use.

Allowed values:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotclaudegrok
frequencystringrequired

The update interval to use.

Allowed values:dailyweeklymonthlyoff

Responses

reportsarray<object>
created_atstring (date)

The date the report was created.

project_idinteger or null

The ID of the project the report is linked to.

prompts_frequencyarray<object>

A record with fields data_source (possible values: chatgpt, copilot, gemini, google_ai_mode, claude, google_ai_overviews, grok, perplexity) and frequency (possible values: daily, weekly, monthly, off).

data_sourcestring
frequencystring
report_idstring

The unique identifier of the report.

report_namestring

The name of the report.