REST-API

Was die API liefert

Sieben lesende Endpunkte, alle mit JSON-Antworten:

• Properties – alle verbundenen Properties, einzeln oder als Liste
• Performance – Klicks, Impressionen, CTR und Position, wahlweise nach Datum, Suchanfrage, Seite, Land oder Gerät
• Keywords – beobachtete Keywords mit aktueller Position
• SCI – Verlauf des Search Console Index inklusive Aufschlüsselung
• Crawls – Liste der Crawls und Detailansicht mit Problemübersicht

Und zwar über den gesamten Zeitraum, den du gespeichert hast – nicht nur die 16 Monate, die Google hergibt.

Berechtigungen je Schlüssel

Beim Anlegen eines API-Keys wählst du, was er darf: properties:read, performance:read, keywords:read, sci:read, crawls:read.

Ein Schlüssel für ein Reporting-Dashboard braucht keinen Zugriff auf Crawl-Daten. Diese Trennung kostet nichts und begrenzt den Schaden, falls ein Schlüssel abhandenkommt.

Sauber gebaut

• Authentifizierung per Header – Authorization: Bearer oder X-API-Key. Bewusst nicht über die URL: Schlüssel in Adressen landen in Server-Logs, Proxys und Browser-Verläufen.
• Nachvollziehbare Fehler – jede Fehlerantwort enthält einen maschinenlesbaren Code und eine verständliche Meldung.
• Transparente Begrenzung – 120 Anfragen pro Minute je Schlüssel, mit X-RateLimit-Remaining und X-RateLimit-Reset in jeder Antwort.
• OpenAPI 3.1 – die vollständige Beschreibung liegt maschinenlesbar bereit und lässt sich direkt in Postman, Insomnia oder einen Client-Generator laden.

Typische Anwendungsfälle

• Eigenes Dashboard: SEO-Kennzahlen neben Umsatz- und Kampagnendaten anzeigen
• Agentur-Reporting: Daten automatisch in bestehende Kundenberichte einspeisen
• Data Warehouse: tägliche Übernahme in die eigene Datenhaltung
• Alerting: eigene Schwellen in vorhandenen Monitoring-Systemen prüfen

Verfügbarkeit

Der API-Zugang gehört ab dem Agency-Plan zum Leistungsumfang. Schlüssel legst du in den Einstellungen unter „API-Zugang" an; der Schlüssel wird genau einmal angezeigt.

Alle Endpunkte mit Parametern und Beispielen: API-Referenz.

Häufige Fragen

Kann ich über die API auch Daten ändern?

Derzeit nicht – die API ist bewusst lesend. Schreibende Endpunkte wie „Crawl starten" sind geplant.

Wie viele Anfragen sind erlaubt?

120 pro Minute je Schlüssel. Jede Antwort enthält Header, aus denen dein Client das verbleibende Kontingent ablesen kann.

Gibt es eine OpenAPI-Datei?

Ja, unter /api/v1/openapi.json. Damit lassen sich Clients für praktisch jede Programmiersprache generieren.

Was passiert, wenn ein Schlüssel abhandenkommt?

Du löschst ihn in den Einstellungen, danach ist er sofort unbrauchbar. Deshalb lohnt es sich, je Anwendung einen eigenen Schlüssel mit möglichst engen Berechtigungen anzulegen.