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

Lister les prompts AEO suivis d'un site web

Renvoie les prompts suivis d'une entité site web et ce que mesurera la prochaine vérification : nombre de prompts actifs et en pause, les limites, la révision de l'ensemble à envoyer avec une modification, une charge approximative par vérification et le calendrier des vérifications. Lecture seule : aucune vérification n'est lancée et aucun crédit n'est consommé. Le suivi des prompts concerne uniquement les entités site web — un établissement physique que vous pouvez voir renvoie 422 entity_type_not_supported — et nécessite la fonctionnalité des entités site web pour votre agence (sinon 403 feature_disabled). Le jeton agit en tant que personne qui l'a émis, dans cette agence : son accès à la page AEO et sa visibilité sur les clients s'appliquent, un jeton limité à des clients est restreint à ces clients, et un site web hors de cette portée renvoie 404. La lecture continue de fonctionner quand la gestion des prompts est désactivée pour l'agence ; canEdit vaut alors false. Jusqu'à la première modification enregistrée, un site web affiche sa liste de prompts existante mise en cache comme prompts importés (managed false, origin existing) : leur provenance est inconnue et ils peuvent ne pas correspondre à ce qu'un rapport a mesuré.

get/api/v1/aeo/prompts
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.
statusstring (all | active | paused)facultatif
Comme filtre de liste : all (par défaut), active ou paused ; toute autre valeur liste tout. Dans une mise à jour : active pour reprendre le prompt, paused pour le mettre en pause. Un prompt en pause reste dans l'ensemble mais est exclu des vérifications.
Réponse
dataobjectfacultatif
locationIdstringfacultatif
L'id d'établissement de l'entité site web.
namestringfacultatif
Le nom du site web.
eligibleboolean (true)facultatif
Toujours true : seule une entité site web a une liste de prompts suivis.
canEditbooleanfacultatif
Indique si la personne qui a émis le jeton peut modifier cet ensemble maintenant : elle a l'autorisation Manage AEO prompts, la gestion des prompts est activée pour l'agence, et l'ancienne liste de prompts n'a pas besoin de rapprochement.
managedbooleanfacultatif
false tant que le site web utilise encore sa liste de prompts existante mise en cache (affichés comme prompts importés de provenance inconnue) ; true dès la première modification enregistrée.
revisionintegerfacultatif
La révision de l'ensemble, incrémentée à chaque modification enregistrée. Envoyez-la comme expectedRevision, ou dans If-Match pour DELETE.
maxActiveintegerfacultatif
Le nombre maximal de prompts actifs en même temps (16).
maxLengthintegerfacultatif
La longueur maximale d'un prompt, en caractères (500).
countsobjectfacultatif
Nombre de prompts actifs et en pause.
activeintegerfacultatif
pausedintegerfacultatif
itemsarray of objectfacultatif
Les prompts dans l'ordre de l'ensemble, filtrés par le paramètre status.
idstringfacultatif
Identifiant unique du prompt.
textstringfacultatif
La formulation du prompt. Dans une vérification ou une entrée d'historique, la formulation mesurée par cette vérification.
normalizedTextstringfacultatif
La formulation nettoyée, espaces regroupés et en minuscules : la clé utilisée pour détecter les doublons.
wordingVersionintegerfacultatif
La version de la formulation : 1 à la création, augmentée de un à chaque modification de formulation. Renvoyez-la comme expectedWordingVersion.
statusstring (active | paused)facultatif
active (mesuré par la prochaine vérification) ou paused (conservé mais exclu des vérifications).
originstring (existing | custom | generated | integration)facultatif
Provenance du prompt : existing (importé de l'ancienne liste de prompts du site web, provenance inconnue), custom (ajouté dans l'application), generated ou integration (ajouté via l'API ou MCP).
createdViastring (ui | api | mcp | import)facultatif
Comment le prompt a été créé : ui, api, mcp ou import.
createdByUserIdstringfacultatif
La personne qui a créé le prompt, ou null si elle est inconnue (prompts importés).
updatedByUserIdstringfacultatif
La personne qui a modifié le prompt en dernier, ou null si elle est inconnue.
positionintegerfacultatif
La place du prompt dans l'ordre de l'ensemble.
createdAtstringfacultatif
Quand le prompt a été créé, sous forme d'horodatage ISO 8601.
updatedAtstringfacultatif
Quand le prompt a été modifié en dernier, sous forme d'horodatage ISO 8601.
deletedAtstringfacultatif
Quand le prompt a été supprimé, ou null. Les prompts supprimés ne sont pas listés mais restent dans les vérifications qui les ont capturés.
latestobjectfacultatif
Le dernier résultat exploitable pour la formulation actuelle, issu d'une vérification clôturée complete, partial ou failed, ou d'une ancienne formulation importée dont la correspondance est prouvée : state checked avec at, measured et expected. Une vérification held reste dans l'historique et ne le fait pas avancer. Sinon state not_checked, y compris juste après une modification.
statestring (not_checked | checked)facultatif
atstringfacultatif
Quand cette vérification a été clôturée, sous forme d'horodatage ISO 8601.
measuredintegerfacultatif
Nombre de moteurs ayant donné une réponse exploitable pour cette formulation.
expectedintegerfacultatif
Nombre de moteurs sélectionnés pour cette vérification.
editedbooleanfacultatif
Indique si la formulation a changé depuis la création du prompt.
workloadobjectfacultatif
Approximativement ce qu'implique une vérification des prompts actifs. La lire ne coûte rien, et l'enregistrement de prompts ne consomme aucun crédit.
activePromptsintegerfacultatif
Prompts actifs que la prochaine vérification mesurerait.
enginesarray of stringfacultatif
Les moteurs d'IA interrogés par une vérification.
answerChecksintegerfacultatif
Prompts actifs × moteurs : les réponses demandées par une vérification. Un décompte, pas des crédits.
estimatedCreditsnumberfacultatif
Crédits approximatifs pour une vérification des prompts actifs, selon les tarifs de crédits de votre agence. null quand le tarif est inconnu ou que plus de 16 prompts sont actifs — inconnu, pas zéro. Une estimation, pas un débit.
creditsPerPromptnumberfacultatif
Crédits approximatifs par prompt sur tous les moteurs, ou null s'ils sont inconnus.
approximateboolean (true)facultatif
Toujours true : les chiffres de charge sont des estimations.
scheduleobjectfacultatif
Le calendrier actuel des vérifications AEO du site web. Modifier les prompts ne le change pas.
frequencystring (weekly | monthly | quarterly | never)facultatif
Fréquence des vérifications : weekly, monthly, quarterly ou never.
nextRunAtstringfacultatif
Quand la prochaine vérification planifiée est prévue, sous forme d'horodatage ISO 8601, ou null quand la fréquence est never ou que les vérifications n'ont pas encore commencé pour ce site web.
activatedbooleanfacultatif
Indique si les vérifications ont commencé pour ce site web (une première vérification a été lancée ou un rapport existe). L'enregistrement de prompts ne les lance pas.
checkInFlightbooleanfacultatif
Indique si une vérification est en file, en cours ou retenue pour ce site web en ce moment. Cette vérification conserve les prompts qu'elle a capturés ; les modifications s'appliquent à partir de la suivante.
listChangedSinceReportbooleanfacultatif
Indique si les prompts actifs diffèrent de ceux mesurés par le rapport actuel, de sorte que le rapport ne reflète pas encore la liste actuelle.
needsReconciliationbooleanfacultatif
Indique si l'ancienne liste de prompts du site web contient des entrées mal formées ou en double. Tant que le support ne l'a pas rapprochée, les modifications renvoient 409 legacy_prompts_need_reconciliation.
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
Votre clé API
locationId *
status
{}

Guides qui utilisent cette ressource