Brand Radar prompts

API only

POST/v3/management/brand-radar-prompts

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

Query parameters

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#/...

outputstring

The output format.

Allowed values:jsonphpxml

Request body

promptsarray<string>Required

A list of custom prompts to add. They must be valid utf8 and less than 400 characters.

Min:1

countriesarray<string>Required

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

Allowed values:adaeafagaialamaoarasatauawazba…

Min:1

tagsarray<string>

A list of tags to assign to the prompts. A tag the report does not have yet is created.

Default:[]

Responses

promptsarray<object>

countrystring

The country of the prompt.

created_atstring (date)

The date the prompt was created.

promptstring

The text of the prompt.

tagsarray<string>

The tags assigned to the prompt.

Parameters

report_idRequired

output

Request Body

{
  "prompts": ["string"],
  "countries": ["ad"],
  "tags": ["string"]
}

API keyRequired

Request

curl "https://api.ahrefs.com/v3/management/brand-radar-prompts" \
  -X POST \
  -H "Authorization: Bearer $AHREFS_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "prompts": ["string"],
  "countries": ["ad"],
  "tags": ["string"]
}'

import requests

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

response = requests.post(url, headers=headers, json={
  "prompts": ["string"],
  "countries": ["ad"],
  "tags": ["string"]
})
print(response.json())

const response = await fetch("https://api.ahrefs.com/v3/management/brand-radar-prompts", {
  method: "POST",
  headers: {
    "Authorization": "Bearer $AHREFS_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "prompts": ["string"],
  "countries": ["ad"],
  "tags": ["string"]
})
});

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

body := []byte(`{
  "prompts": ["string"],
  "countries": ["ad"],
  "tags": ["string"]
}`)
req, _ := http.NewRequest("POST", "https://api.ahrefs.com/v3/management/brand-radar-prompts", 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

{
  "prompts": [
    {
      "country": "string",
      "created_at": "string",
      "prompt": "string",
      "tags": ["string"]
    }
  ]
}