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

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 nichos de mercado das suas marcas. Obsoleto em 2026-05-18, este parâmetro não terá mais efeito logo após essa data.

competitors

Pelo menos um dos campos brand, competitors ou market precisa estar preenchido (não vazio).

Recomendado. Permite especificar nomes de marcas e grupos de URLs para um direcionamento preciso.

At least one of names or url_groups is required

namesarray<string>

Os nomes da marca/concorrente

Example:["ahrefs","ahrefs seo"]

url_groupsarray<object>

targetstring (domain)required

O domínio do alvo

Example:ahrefs.com

scopestringrequired

Escopo do alvo.

Allowed values:urlpathdomainsubdomains

brand

Pelo menos um dos campos brand, competitors ou market precisa estar preenchido (não vazio).

Recomendado. Permite especificar nomes de marcas e grupos de URLs para um direcionamento preciso.

At least one of names or url_groups is required

namesarray<string>

Os nomes da marca/concorrente

Example:["ahrefs","ahrefs seo"]

url_groupsarray<object>

targetstring (domain)required

O domínio do alvo

Example:ahrefs.com

scopestringrequired

Escopo do alvo.

Allowed values:urlpathdomainsubdomains

Respostas

reportsarray<object>

created_atstring (date)

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, google_ai_mode, google_ai_overviews, grok, perplexity) e frequency (valores possíveis: daily, weekly, monthly, off).

data_sourcestring

frequencystring

report_idstring

O identificador exclusivo do relatório.

report_namestring

O nome do relatório.

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 } ] } ] }'

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