Docs
Pesquisar na documentação...⌘K

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

brand

Pelo menos um dos campos brand ou competitors deve estar preenchido.

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.

Valores permitidos:urlpathdomainsubdomains
competitors

Pelo menos um dos campos brand ou competitors deve estar preenchido.

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.

Valores permitidos:urlpathdomainsubdomains
namestring

O nome do relatório.

project_idinteger

O ID do projeto a ser usado.

content_filterobject

Optional phrases used to include or exclude results based on their content.

includearray<string>

Only show results containing at least one of these exact phrases.

excludearray<string>

Hide results containing any of these exact phrases.

prompts_frequencyarray<object>

A frequência de prompts a ser usada.

Min:1
data_sourcestringrequired

A fonte de dados a ser usada.

Valores permitidos:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotclaudegrok
frequencystringrequired

O intervalo de atualização a ser usado.

Valores permitidos:dailyweeklymonthlyoff

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