Grundlagen

Diese Regeln gelten für alle Endpunkte der Data Export API.

Rate LimitLink zur Überschrift kopieren

Pro Token sind 300 Anfragen pro Minute möglich. Darüber antwortet die API mit Status 429. Der Header Retry-After gibt an, nach wie vielen Sekunden du die nächste Anfrage senden kannst.

HTTP/1.1 429 Too Many Requests
Retry-After: 23

{ "message": "Too Many Attempts." }

DatumsangabenLink zur Überschrift kopieren

• Ausgabe: ISO 8601 in UTC, zum Beispiel 2026-01-31T12:00:00.000000Z.
• Eingabe (from, to): ein Datum oder ein Zeitpunkt. Ein reines Datum wie 2026-01-31 umfasst den ganzen Tag in UTC. Zeitpunkte mit Zeitzone (2026-01-31T08:00:00+01:00) werden nach UTC umgerechnet.
• Beide Grenzen zählen mit. to darf nicht vor from liegen.

PaginationLink zur Überschrift kopieren

Listen sind nach Zeit absteigend sortiert (neueste zuerst) und werden mit einem Cursor durchlaufen. Folge der absoluten URL in links.next, bis sie null ist.

Aufbau jeder Liste:

{
  "data": [ ... ],
  "links": {
    "first": "https://app.poll-hero.com/api/v1/surveys",
    "prev": null,
    "next": "https://app.poll-hero.com/api/v1/surveys?page%5Bcursor%5D=eyJ0IjoiMjAyNi0w..."
  },
  "meta": { "page_size": 50 }
}

• links.next enthält alle Parameter deiner Anfrage (Filter, Attribute, Zeitraum). Du musst sie nicht erneut anhängen.
• Es geht nur vorwärts: links.prev ist immer null.
• Eine Gesamtanzahl wird nicht zurückgegeben. meta.page_size ist die angefragte Seitengröße, nicht die Zahl der gelieferten Einträge.
• Der Cursor ist ein interner Wert. Baue oder verändere ihn nicht selbst, sonst antwortet die API mit 422.

WahrheitswerteLink zur Überschrift kopieren

Parameter wie completed oder include_deleted erwarten true oder false. Alternativ funktionieren 1 und 0.

FehlerLink zur Überschrift kopieren

Fehler kommen immer als JSON mit einem Feld message zurück. Bei ungültigen Parametern enthält errors die Meldungen je Parameter.

HTTP/1.1 422 Unprocessable Content

{
  "message": "The page.size field must not be greater than 100.",
  "errors": {
    "page.size": ["The page.size field must not be greater than 100."]
  }
}

Die Fehlermeldungen sind auf Englisch.