Synup
Créer une clé
v1Ressources/SEO/postTélécharger un rapport de classement personnalisé

Télécharger un rapport de classement personnalisé

Génère le rapport de classement personnalisé et à sections configurables — la même action "Télécharger le rapport" dans l'application. Renvoie du HTML rendu, pas un PDF binaire : le rendu en PDF se fait dans le navigateur (aucun moteur de rendu Chrome sans interface ne s'exécute côté serveur), donc la conversion en fichier PDF réel incombe à l'appelant, la même contrainte que celle de l'interface de l'application elle-même. Distinct de POST /api/v1/seo/reports/generate, qui ne fait que mettre en file d'attente un scan de grille de classement en arrière-plan et ne renvoie aucun document.

post/api/v1/seo/reports
seo:read
Corps de la requête
locationIdstringobligatoire
L'établissement sur lequel produire le rapport.
presetstringfacultatif
Préréglage de plage de dates, par ex. "lastMonth" (par défaut).
fromstringfacultatif
Début de la plage personnalisée (date ISO). Nécessite to.
tostringfacultatif
Fin de la plage personnalisée (date ISO). Nécessite from.
keywordsarray of stringfacultatif
Limiter à ces ids de mots-clés suivis. Omettre pour tous les inclure.
sectionsobjectfacultatif
Quelles sections du rapport inclure, par clé. Les clés omises utilisent les valeurs par défaut du rapport.
coverPagebooleanfacultatif
executiveSummarybooleanfacultatif
performanceSnapshotbooleanfacultatif
agencyActivityLogbooleanfacultatif
gridRankSnapshotsbooleanfacultatif
keywordPerformanceTablebooleanfacultatif
monthOverMonthTrendbooleanfacultatif
competitorLandscapebooleanfacultatif
aiRecommendationsbooleanfacultatif
notesstringfacultatif
Notes en texte libre à inclure dans le rapport.
localestringfacultatif
Langue du rapport généré. Par défaut en.
Réponse
dataobjectfacultatif
htmlstringfacultatif
Le rapport généré sous forme de document HTML autonome.
filenamestringfacultatif
Nom de fichier suggéré pour le rapport.
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.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
502Le rapport n'a pas pu être généré (une défaillance de la source de données, pas une erreur du client).
post/api/v1/seo/reports
Votre clé API
Corps de la requête*
{
  "data": {
    "html": "<style>#seo-report{width:100%;...}</style><div id=\"seo-report\"><section class=\"cover\"><h1>Ranking Analytics Report</h1><div class=\"biz\">Acme Dental — Downtown</div></section>...</div>",
    "filename": "Acme_Dental_Downtown_RankingReport_Jan2026_Feb2026.pdf"
  }
}

Guides qui utilisent cette ressource