Prérequis
- Une clé API AthenaHQ ayant accès au site web (Organisation → onglet API). Consultez Authentification. Une clé dédiée limitée à ce seul site est le choix le plus sûr pour une tâche planifiée.
- Le
website_iddu site sur lequel vous souhaitez établir des rapports. Récupérez-le avecGET /api/v1/websites. - Une vue enregistrée pour ce site, créée dans le tableau de bord.
Configuration
1
Trouver l’identifiant de la vue enregistrée
id de la vue dont le name vous intéresse. Cet identifiant ne change pas lorsque quelqu’un modifie la vue dans le tableau de bord ; l’exportation suit donc ces modifications.2
Demander un mois de métriques pour la vue
is_self: true) et chaque concurrent sélectionné dans la vue.3
Planifier l’exportation
Exécutez la requête une fois par mois pour le mois écoulé et ajoutez les lignes, accompagnées du mois, à votre table. Par exemple, en Python :
Quel chiffre correspond au tableau de bord
La carte Taux de mention du tableau de bord affiche par défaut le taux pertinent. Dans l’API, il s’agit derelative_mention_rate : les mentions de la marque divisées par les réponses mentionnant votre marque ou un concurrent de la vue. mention_rate correspond au mode absolu de la carte : les mentions divisées par toutes les réponses de la vue. Pour votre marque, lisez l’entrée portant is_self: true.
Comme le taux pertinent compte les réponses mentionnant n’importe lequel des concurrents de la vue, modifier leur liste change aussi votre propre taux pertinent, dans le tableau de bord comme ici.
Application de la vue
- Dates.
start_dateetend_datedéterminent la période ; la plage de dates enregistrée avec la vue est ignorée. Envoyez des dates simples (YYYY-MM-DD).end_dateest inclusive. - Valeurs par défaut. Comme le tableau de bord, la vue ne compte que les prompts actifs et inclut tous les modèles, sauf indication contraire de la vue. Une requête sans
saved_view_idconserve les valeurs par défaut de l’API, qui incluent les prompts en pause. - Remplacements. Tout filtre envoyé à côté de
saved_view_idremplace la valeur de ce champ dans la vue. Par exemple,"models": ["chatgpt"]lit la vue pour ChatGPT uniquement. - Filtres des autres pages. Une vue enregistrée est partagée avec les pages Prompts, Réponses et Sources. Les filtres propres à ces pages, comme le sentiment ou les étiquettes de sources, ne modifient pas les métriques du tableau de bord et ne les modifient pas ici non plus.
- Toutes les métriques. Le même
saved_view_idfonctionne pour tous les points de terminaison de métriques : taux de mention, part de voix, taux de citation et position, sous forme cumulée ou chronologique. Les outils MCP de métriques (get_mention_rate_cumulativeet les autres) l’acceptent également.