Passer au contenu principal
Chaque chiffre d’un rapport de moniteur provient de réponses notées que vous pouvez ouvrir. Cette page couvre les endpoints de lecture qui les montrent : quelles sources sont citées, comment les citations évoluent dans le temps, la réponse derrière une note, un prompt en détail, les réponses par localisation, et l’export complet. Ils ne lisent que des résultats enregistrés et ne coûtent donc rien.

Quelles sources sont citées

GET /v1/monitors/{id}/sources (référence) classe les domaines ou pages que les moteurs ont cités, avec la même fenêtre et les mêmes filtres que le rapport. Il compte des réponses distinctes, pas des citations brutes : une page citée trois fois dans une réponse compte une fois.
Par exemple :
Les lignes sont triées par citations, puis par key. nextCursor vaut null sur la dernière page ; il n’y a pas de coupe aux N premiers : chaque domaine ou page cité dans la fenêtre est accessible. Traitez le curseur comme opaque.

Citations dans le temps

GET /v1/monitors/{id}/citations (référence) renvoie les données des graphiques de citations du tableau de bord : les totaux de la fenêtre, une série quotidienne, et les 20 principaux domaines et pages, chacun avec sa propre série quotidienne.
Ici, une citation est une page dans une réponse : citations compte donc des pages citées, pas des réponses. /sources compte des réponses distinctes : ses chiffres peuvent donc différer. kind vaut owned pour vos domaines ; les autres types proviennent d’une liste fixe d’éditeurs connus, et tout domaine inconnu est other. La part d’une source est son citations divisé par totals.citations. kind, q et offset ne restreignent que domains, pages et pagination ; totals, days et types couvrent toujours toutes les sources de la fenêtre.

Lire une réponse

GET /v1/monitors/{id}/answers/{taskId} (référence) renvoie la réponse enregistrée derrière une note, avec ce à quoi elle a été comparée, pour qu’une mention puisse être vérifiée plutôt que crue sur parole. Les ids de tâche proviennent de evidenceTaskId, mentionTaskId et latestTaskId dans un rapport, de /sources et des lignes exportées.
Par exemple :
Un id de tâche qui n’est pas une réponse notée de ce moniteur renvoie 404 NOT_FOUND.

Un prompt en détail

GET /v1/monitors/{id}/prompt (référence) renvoie les données d’un prompt. prompt (texte exact) est obligatoire et fonctionne pour les prompts que vous avez depuis retirés du moniteur ; days vaut 7, 30 (par défaut) ou 90.
Ici, citations compte les pages citées dans l’ensemble des réponses, pas des réponses distinctes. Pour une liste de sources complète et paginée pour un prompt, utilisez /sources?prompt=....

Réponses par localisation

GET /v1/monitors/{id}/grid (référence) renvoie les réponses d’un moniteur par point de sa localisation ou grille actuelle. Les paramètres facultatifs engine (l’un des moteurs du moniteur) et prompt la restreignent ; days vaut 7, 30 (par défaut) ou 90. La réponse contient location, grid, engine, prompt, windowDays et points. Chaque point a row, col, location, runs, mentioned, cited, topCompetitor ({ name, mentions } ou null) et latest ({ taskId, engine, mentioned, ranAt } de la réponse la plus récente, ou null). Les réponses sont associées aux points par leurs coordonnées exactes : les réponses issues d’une localisation ou d’une grille antérieure du même moniteur sont donc exclues. Un moniteur sans localisation ni grille ne renvoie aucun point.

Exporter les réponses notées

GET /v1/monitors/{id}/results (référence) renvoie les réponses notées elles-mêmes, pour un chargement en entrepôt de données, un tableur ou une présentation. Pour livrer plutôt chaque nouvelle réponse vers un stockage cloud selon un calendrier, voir Exports de résultats.
La réponse JSON, par exemple :
Les lignes sont triées de la plus récente à la plus ancienne. La pagination est un keyset sur ranAt (à la microseconde près) et l’id de ligne : des lignes partageant un horodatage ne sont jamais sautées ni répétées. Pour une extraction reproductible, envoyez des since et until explicites, gardez-les fixes, et suivez nextCursor jusqu’à ce qu’il vaille null. Changer la fenêtre entre deux pages peut sauter ou répéter des lignes. Traitez le curseur comme opaque.

CSV

Avec format=csv, la réponse est en text/csv, UTF-8 avec BOM pour que les tableurs l’ouvrent correctement. Un corps CSV ne peut pas porter la pagination : elle passe donc dans les en-têtes. Les colonnes sont ran_at, monitor, engine, prompt, mentioned, cited, position, competitors, task_id, plus answer_text, sources, scoring_context avec includeEvidence=true. competitors joint les noms avec | ; sources et scoring_context contiennent du texte JSON. Une cellule qui commence par =, +, -, @, une tabulation ou un retour chariot est préfixée par ' : le texte d’un moteur ne peut donc pas devenir une formule de tableur.

Erreurs et limites

Des paramètres invalides renvoient 400 VALIDATION_ERROR en nommant le problème, y compris un curseur qui n’a pas été renvoyé par la page précédente. Un moniteur d’un autre compte, ou un id de tâche inconnu, renvoie 404 NOT_FOUND. Voir Moniteurs pour les codes communs.

Étapes suivantes

Événements et alertes

Recevez un webhook quand les réponses d’un prompt changent.

Exports de résultats

Livrez les réponses notées vers votre propre stockage selon un calendrier.