Synup
Créer une clé
v1Ressources/AEO/getLister les vérifications de prompts d'un site web

Lister les vérifications de prompts d'un site web

Renvoie les vérifications de prompts du site web, de la plus récente à la plus ancienne, sans leurs réponses : quand chacune a été capturée et clôturée, son statut, la révision de l'ensemble et les moteurs mesurés, et combien de réponses étaient exploitables. Un rapport archivé datant d'avant la gestion des prompts apparaît avec source legacy_report. Lecture seule : lister ne lance jamais de vérification.

get/api/v1/aeo/prompts/checks
aeo:read
Paramètres de requête
locationIdstringobligatoire
L'id d'établissement de l'entité site web. Un site web que vous ne pouvez pas voir, ou qui n'existe pas, renvoie 404 ; un établissement physique renvoie 422 entity_type_not_supported.
limitintegerfacultatif
Nombre de vérifications à renvoyer, de la plus récente à la plus ancienne : de 1 à 100, 24 par défaut. Les valeurs hors de cette plage sont ramenées à la limite.
Réponse
dataarray of objectfacultatif
idstringfacultatif
Identifiant unique de la vérification.
capturedAtstringfacultatif
Quand la vérification a capturé les prompts qu'elle mesure, sous forme d'horodatage ISO 8601.
settledAtstringfacultatif
Quand la vérification s'est terminée, ou null tant qu'elle est en cours.
statusstring (captured | running | complete | partial | failed | held)facultatif
captured, running, complete, partial (certaines réponses manquent), failed ou held (le résultat est inconnu et doit être rapproché ; ni terminée ni en échec). Une vérification failed ou held peut s'être arrêtée avant que toutes les réponses attendues aient été demandées.
promptSetRevisionintegerfacultatif
La révision de l'ensemble capturée par la vérification.
promptCountintegerfacultatif
Nombre de prompts capturés par la vérification.
enginesarray of stringfacultatif
Les moteurs d'IA sélectionnés pour cette vérification.
measuredintegerfacultatif
Nombre de réponses exploitables.
expectedintegerfacultatif
Nombre de réponses attendues pour les prompts et moteurs capturés.
publicationstring (published | superseded)facultatif
published quand les résultats de la vérification sont devenus le rapport du site web, superseded quand un résultat plus récent avait déjà pris sa place, ou null.
sourcestring (legacy_report)facultatif
legacy_report pour un rapport archivé datant d'avant la gestion des prompts ; absent pour une vérification de prompts.
legacyEnginesarray of objectfacultatif
Anciens rapports archivés uniquement : le score de chaque moteur et ses nombres de prompts mesurés et attendus tels que le rapport les a enregistrés. Une valeur non enregistrée vaut null, jamais zéro.
enginestringfacultatif
scorenumberfacultatif
measuredPromptsintegerfacultatif
expectedPromptsintegerfacultatif
Erreurs
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
422Il manque un paramètre requis à la requête, ou elle est invalide.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
503Le service est temporairement indisponible. Suivez les consignes de nouvelle tentative propres à cette opération.
get/api/v1/aeo/prompts/checks
Votre clé API
locationId *
limit
{}

Guides qui utilisent cette ressource