Brand Radar Reports

API only

PATCH/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>Required

The prompts frequency to use.

data_sourcestringrequired

The data source to use.

Allowed values:chatgptcopilotgeminigoogle_ai_modegoogle_ai_overviewsgrokperplexity

frequencystringrequired

The update interval to use.

Allowed values:dailyweeklymonthlyoff

report_idstringRequired

The ID of the report to use. You can find it in the URL of your Brand Radar report in Ahrefs: https://app.ahrefs.com/brand-radar/reports/#report_id#/...

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, 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.

curl "https://api.ahrefs.com/v3/management/brand-radar-reports" \ -X PATCH \ -H "Authorization: Bearer $AHREFS_API_KEY" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ --data-raw '{ "prompts_frequency": [ { "data_source": "chatgpt", "frequency": "daily" } ], "report_id": "string" }'

{ "reports": [ { "created_at": "string", "project_id": 0, "prompts_frequency": [ { "data_source": "string", "frequency": "string" } ], "report_id": "string", "report_name": "string" } ] }