Relatórios do Brand Radar

Somente API

POST/v3/management/brand-radar-reports

As solicitações para este endpoint são gratuitas e não consomem unidades da API.

Parâmetros de consulta

outputstring

O formato de saída.

Valores permitidos:jsonphp

Corpo da solicitação

prompts_frequencyarray<object>

A frequência de prompts a ser usada.

data_sourcestringrequired

A fonte de dados a ser usada.

Allowed values:chatgptgeminiperplexitycopilot

frequencystringrequired

O intervalo de atualização a ser usado.

Allowed values:dailyweeklymonthlyoff

project_idinteger

O ID do projeto a ser usado.

namestring

O nome do relatório.

marketarray<string>

Uma lista dos mercados de nicho das suas marcas.

competitorsarray<string>

Uma lista de concorrentes das suas marcas.

brandarray<string>

Uma lista das suas marcas. É necessário que pelo menos um entre marca, concorrentes ou mercado não esteja vazio.

Respostas

reportsarray<object>

report_idstring

O identificador exclusivo do relatório.

report_namestring

O nome do relatório.

created_atstring

A data em que o relatório foi criado.

project_idinteger or null

O ID do projeto ao qual o relatório está vinculado.

prompts_frequencyarray<object>

Um registro com os campos data_source (valores possíveis: chatgpt, copilot, gemini, perplexity) e frequency (valores possíveis: daily, weekly, monthly, off).

Parâmetros

output

Corpo da Solicitação

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

Chave de API

Solicitação

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": ["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": "chatgpt",
      "frequency": "daily"
    }
  ],
  "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": "chatgpt",
      "frequency": "daily"
    }
  ],
  "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": "chatgpt",
      "frequency": "daily"
    }
  ],
  "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))

Resposta

200 OK

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