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:jsoncsvxmlphp

Request body

prompts_frequencyarray<object>

The prompts frequency to use.

data_sourcestringrequired

The data source to use. Possible values: chatgpt, gemini, perplexity, copilot.

frequencystringrequired

The update interval to use. Possible values: daily, weekly, monthly, off.

project_idinteger

The ID of the project to use.

namestring

The name of the report.

marketarray<string>

A comma-separated list of the niche markets of your brands.

competitorsarray<string>

A comma-separated list of competitors of your brands.

brandarray<string>

A comma-separated list of your brands. At least one of brand, competitors or market is required to be non-empty.

Responses

reportsarray<object>

report_idstring

The unique identifier of the report.

report_namestring

The name of the report.

created_atstring

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

Parameters

output

Request Body

{
  "prompts_frequency": [
    {
      "data_source": "string",
      "frequency": "string"
    }
  ],
  "project_id": 0,
  "name": "string",
  "market": ["string"],
  "competitors": ["string"],
  "brand": ["string"]
}

API key

Request

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": "string",
      "frequency": "string"
    }
  ],
  "project_id": 0,
  "name": "string",
  "market": ["string"],
  "competitors": ["string"],
  "brand": ["string"]
}'

import requests

url = "https://api.ahrefs.com/v3/management/brand-radar-reports"
headers = {
    "Authorization": "Bearer $AHREFS_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers, json={
  "prompts_frequency": [
    {
      "data_source": "string",
      "frequency": "string"
    }
  ],
  "project_id": 0,
  "name": "string",
  "market": ["string"],
  "competitors": ["string"],
  "brand": ["string"]
})
print(response.json())

const response = await fetch("https://api.ahrefs.com/v3/management/brand-radar-reports", {
  method: "POST",
  headers: {
    "Authorization": "Bearer $AHREFS_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "prompts_frequency": [
    {
      "data_source": "string",
      "frequency": "string"
    }
  ],
  "project_id": 0,
  "name": "string",
  "market": ["string"],
  "competitors": ["string"],
  "brand": ["string"]
})
});

const data = await response.json();
console.log(data);

body := []byte(`{
  "prompts_frequency": [
    {
      "data_source": "string",
      "frequency": "string"
    }
  ],
  "project_id": 0,
  "name": "string",
  "market": ["string"],
  "competitors": ["string"],
  "brand": ["string"]
}`)
req, _ := http.NewRequest("POST", "https://api.ahrefs.com/v3/management/brand-radar-reports", bytes.NewBuffer(body))
req.Header.Set("Authorization", "Bearer $AHREFS_API_KEY")
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

data, _ := io.ReadAll(resp.Body)
fmt.Println(string(data))

Response

200 OK

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