Synup
Schlüssel erstellen
v1Ressourcen/SEO/postEinen gebrandeten Ranking-Bericht herunterladen

Einen gebrandeten Ranking-Bericht herunterladen

Erstellt den gebrandeten, in Abschnitte konfigurierbaren Ranking-Bericht — dieselbe Aktion "Bericht herunterladen" in der App. Liefert gerendertes HTML, kein binäres PDF: Das Rendern zu PDF geschieht im Browser (serverseitig läuft kein Headless-Chrome-Renderer), sodass das Erzeugen einer tatsächlichen PDF-Datei beim Aufrufer liegt — dieselbe Einschränkung, die die eigene UI der App hat. Unterscheidet sich von POST /api/v1/seo/reports/generate, das nur einen Hintergrund-Scan des Ranking-Rasters einreiht und kein Dokument liefert.

post/api/v1/seo/reports
seo:read
Anfragetext
locationIdstringerforderlich
Der Standort, über den berichtet werden soll.
presetstringoptional
Voreinstellung für den Zeitraum, z. B. "lastMonth" (Standard).
fromstringoptional
Beginn des benutzerdefinierten Zeitraums (ISO-Datum). Erfordert to.
tostringoptional
Ende des benutzerdefinierten Zeitraums (ISO-Datum). Erfordert from.
keywordsarray of stringoptional
Auf diese verfolgten Keyword-IDs beschränken. Weglassen für alle.
sectionsobjectoptional
Welche Berichtsabschnitte enthalten sein sollen, nach Schlüssel. Weggelassene Schlüssel verwenden die Standardwerte des Berichts.
coverPagebooleanoptional
executiveSummarybooleanoptional
performanceSnapshotbooleanoptional
agencyActivityLogbooleanoptional
gridRankSnapshotsbooleanoptional
keywordPerformanceTablebooleanoptional
monthOverMonthTrendbooleanoptional
competitorLandscapebooleanoptional
aiRecommendationsbooleanoptional
notesstringoptional
Freitext-Notizen, die in den Bericht aufgenommen werden.
localestringoptional
Sprache des gerenderten Berichts. Standardmäßig en.
Antwort
dataobjectoptional
htmlstringoptional
Der gerenderte Bericht als eigenständiges HTML-Dokument.
filenamestringoptional
Vorgeschlagener Dateiname für den Bericht.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
502Der Bericht konnte nicht erstellt werden (ein Datenquellenfehler, kein Client-Fehler).
post/api/v1/seo/reports
Ihr API-Schlüssel
Anfragetext*
{
  "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"
  }
}

Anleitungen, die diese Ressource verwenden