Docs
Rechercher dans la documentation...⌘K

Rapports de Brand Radar

API uniquement
POST/v3/management/brand-radar-reports

Les requêtes vers ce point de terminaison sont gratuites et ne consomment aucune unité d’API.

Paramètres de requête

outputstring

Le format de sortie.

Valeurs autorisées:jsonphp

Corps de la requête

brand

Au moins l’un des éléments brand ou competitors doit être non vide.

Recommandé. Vous pouvez préciser des noms de marque et des groupes d’URL pour un ciblage précis.

At least one of names or url_groups is required
namesarray<string>

Les noms de la marque/du concurrent

Example:["ahrefs","ahrefs seo"]
url_groupsarray<object>
targetstring (domain)required

Le domaine de la cible

Example:ahrefs.com
scopestringrequired

Portée de la cible.

Valeurs autorisées:urlpathdomainsubdomains
competitors

Au moins l’un des éléments brand ou competitors doit être non vide.

Recommandé. Vous pouvez préciser des noms de marque et des groupes d’URL pour un ciblage précis.

At least one of names or url_groups is required
namesarray<string>

Les noms de la marque/du concurrent

Example:["ahrefs","ahrefs seo"]
url_groupsarray<object>
targetstring (domain)required

Le domaine de la cible

Example:ahrefs.com
scopestringrequired

Portée de la cible.

Valeurs autorisées:urlpathdomainsubdomains
namestring

Le nom du rapport.

project_idinteger

L’ID du projet à utiliser.

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>

La fréquence des prompts à utiliser.

Min.:1
data_sourcestringrequired

Source de données à utiliser.

Valeurs autorisées:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotclaudegrok
frequencystringrequired

Intervalle de mise à jour à utiliser.

Valeurs autorisées:dailyweeklymonthlyoff

Réponses

reportsarray<object>
created_atstring (date)

La date de création du rapport.

project_idinteger or null

L’ID du projet auquel le rapport est associé.

prompts_frequencyarray<object>

Un enregistrement comportant les champs data_source (valeurs possibles : chatgpt, copilot, gemini, google_ai_mode, claude, google_ai_overviews, grok, perplexity) et frequency (valeurs possibles : daily, weekly, monthly, off).

data_sourcestring
frequencystring
report_idstring

L’identifiant unique du rapport.

report_namestring

Le nom du rapport.