Synup
Créer une clé
v1Ressources/AEO/postMettre en file la génération d'un rapport AEO

Mettre en file la génération d'un rapport AEO

Démarre une génération en arrière-plan d'un nouveau rapport AEO pour un établissement. La génération de rapport exécute plusieurs appels LLM par moteur/prompt et ne s'exécute jamais de façon synchrone dans la requête — cet appel met le job en file et renvoie immédiatement. Il n'existe pas de ressource séparée d'id de job ou de statut : interrogez GET /api/v1/aeo/reports pour le même établissement et surveillez le champ generating jusqu'à ce qu'il repasse à false. Non disponible pour les établissements antérieurs au cache d'établissement legacy de Synup (établissements natifs uniquement).

post/api/v1/aeo/reports/enqueue
aeo:write
Corps de la requête
locationIdstringobligatoire
L'établissement pour lequel générer un rapport.
clientIdstringfacultatif
Le client de l'établissement.
forcebooleanfacultatif
Quand true, démarre une nouvelle génération même si un rapport a déjà été généré ce mois-ci.
Réponse
dataobjectfacultatif
enqueuedbooleanfacultatif
Toujours true — le job de génération a été mis en file.
forcebooleanfacultatif
Renvoie l'indicateur force de la requête.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
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.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/aeo/reports/enqueue
Votre clé API
Corps de la requête*
{
  "data": {
    "enqueued": true,
    "force": false
  }
}

Guides qui utilisent cet endpoint