Direkt zum Hauptinhalt

Abruf von Gast-Daten (pull)

Aufruf

Der Abruf der Gast-Daten erfolgt über eine HTTP-GET-Anfrage an folgende URL:

https://gwatch.events/ext-api/pull

Zur Authentifizierung ist im Request-Header der API-Hauptschlüssel mit dem Schlüssel X-Api-key zu übergeben.

Varianten / Datenansichten

Die zurückgegebenen Inhalte können serverseitig individuell konfiguriert werden. Falls mehrere Varianten (sogenannte Flavors) existieren, erhalten Sie für jede Variante einen separaten Schlüssel, der im Header als X-Api-flavor übergeben werden muss.

Für jede Variante kann optional ein eigener IP-Filter definiert sein.

Optionale GET-Parameter

Folgende Parameter können zusätzlich in der URL übergeben werden:

  • limit
    Die API liefert pro Aufruf maximal 2.500 Datensätze zurück.
    Bei komplexen internen Berechnungen (z. B. bei kombinierten Feldwerten) kann eine Reduktion des Limits hilfreich sein, um Timeouts zu vermeiden.
  • offset
    Um mehr als limit Datensätze abzufragen, kann ein Offset-Wert verwendet werden. Fehlt dieser, wird automatisch 0 angenommen.
    Beispielhafte Paginierung:
    • 1. Aufruf: limit=100
    • 2. Aufruf: limit=100&offset=100
    • 3. Aufruf: limit=100&offset=200
    • usw.
  • changesUntil
    Zur effizienten Synchronisation Ihres Datenbestands können Sie mit diesem Parameter nur Datensätze abrufen, die seit einem bestimmten Zeitpunkt geändert wurden.
    Format: YYYY-MM-DDTHH:MM:SS
    Beispiel: changesUntil=2025-04-08T15:00:00