Passer au contenu principal
Utilisez une clé API globale de l’organisation avec un accès administrateur. Votre organisation doit disposer de l’accès à Pitch Workspace et d’un quota de rapports disponible.

Créer

Choisissez une clé de requête par rapport. Conservez la même clé lorsque vous réessayez après une expiration du délai ou une erreur temporaire.
La réponse est 202 Accepted. Seul website_url est obligatoire. Les champs facultatifs country et language ont pour valeurs par défaut United States et English. La recherche prépare le profil de l’entreprise, les concurrents et les prompts avant l’exécution du rapport Pitch Workspace standard. Un rapport en cours de traitement peut d’abord afficher le domaine soumis et des résultats vides. Les rapports étudient 20 prompts et interrogent ChatGPT, Perplexity, Gemini et Copilot. Le rapport affiche les 11 modèles pris en charge et met en évidence ceux qui ont des résultats.

Interroger l’état

Interrogez l’API toutes les 10 secondes et consultez pitch.status dans la réponse détaillée existante. Arrêtez-vous à completed ou failed. Les rapports terminés incluent les concurrents, prompts, sources, attributs et métriques. Partagez report_url une fois le rapport terminé. Toute personne disposant du lien peut le consulter. La création n’envoie aucun e-mail ; votre application décide quand et comment le transmettre.

Nouvelles tentatives et quota

  • Chaque rapport accepté consomme un rapport du quota, y compris si sa recherche ou sa génération échoue ensuite. Les organisations illimitées ne consomment pas de quota fini.
  • Réutiliser la même clé et les mêmes données normalisées renvoie le même rapport sans second débit. Un corps différent avec la même clé renvoie 409.
  • Une nouvelle clé demande un nouveau rapport, même pour le même site web.
  • La création autorise trois rapports API simultanés par organisation et 10 requêtes par minute. Respectez Retry-After dans les réponses 429.
  • En cas de 500 temporaire, réessayez avec la même clé de requête. Ne changez pas de clé pour contourner une erreur de facturation. Une opération de facturation non résolue peut nécessiter une régularisation par l’assistance ; le quota réservé reste bloqué pour éviter une double consommation.
Consultez Créer un rapport de prospection pour le schéma complet de la requête et de la réponse.