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

prompts_frequencyarray<object>

The prompts frequency to use.

data_sourcestringrequired

The data source to use.

Allowed values:chatgptgeminiperplexitycopilot

frequencystringrequired

The update interval to use.

Allowed values:dailyweeklymonthlyoff

project_idinteger

The ID of the project to use.

namestring

The name of the report.

marketarray<string>

A list of the niche markets of your brands.

competitors

At least one of brand, competitors or market 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

brand

At least one of brand, competitors or market 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

Responses

reportsarray<object>

report_idstring

The unique identifier of the report.

report_namestring

The name of the report.

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, perplexity) and frequency (possible values: daily, weekly, monthly, off).

curl "https://api.ahrefs.com/v3/management/brand-radar-reports" \ -X POST \ -H "Authorization: Bearer $AHREFS_API_KEY" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ --data-raw '{ "prompts_frequency": [ { "data_source": "chatgpt", "frequency": "daily" } ], "project_id": 0, "name": "string", "market": ["string"], "competitors": [ { "names": ["ahrefs","ahrefs seo"], "url_groups": [ { "target": null, "scope": null } ] } ], "brand": [ { "names": ["ahrefs","ahrefs seo"], "url_groups": [ { "target": null, "scope": null } ] } ] }'