Ereignisse auflisten

Parameter

Lingara-Versionheaderstringoptional

Die API-Version, unter der diese Anfrage beantwortet wird. Ohne sie erhält ein Zugriffstoken die Version, an die sein Client gebunden ist, und eine Anfrage ohne Token die aktuelle Version. Die Version in Entwicklung ist nur erreichbar, indem man sie hier nennt. Eine unbekannte Version wird mit 400 und dem Code api_version_unknown beantwortet. GET /v1/versions listet die Versionen auf.

cursorquerystringoptional

Wo fortgefahren wird: der next_cursor einer früheren Seite oder die id: eines Stream-Ereignisses. Ein Cursor, der älter als 30 Tage ist, wird mit 410 und dem Code cursor_expired beantwortet.

startquerystringoptional

Wo ohne Cursor begonnen wird: latest für Ereignisse ab jetzt oder oldest für jedes noch aufbewahrte Ereignis.

typesqueryarray of stringoptional

Nur diese Ereignistypen, durch Kommas getrennt. Ohne diesen Parameter jeder Typ, den die Scopes Ihres Tokens lesen dürfen.

limitqueryintegeroptional

Die höchste Anzahl an Ereignissen pro Seite, von 1 bis 100.

Antworten

200 Eine Seite Ereignisse und der Cursor zum Fortfahren

itemsarray of EventEnvelopeerforderlich

idstringerforderlich

typestringerforderlich

created_atstringerforderlich

api_versionstringerforderlich

subjectstringerforderlich

dataobjecterforderlich

next_cursorstringerforderlich

has_morebooleanerforderlich

Fehler

410application/json

api_version_discontinued: Die API-Version dieser Anfrage wurde eingestellt. cursor_expired: Der Cursor ist älter als 30 Tage; beginnen Sie ohne ihn neu.

4XXapplication/json

Die Anfrage wurde abgelehnt. code nennt den Grund, und error beschreibt ihn in Worten.

503application/json · text/plain

Der Dienst ist vorübergehend nicht verfügbar; versuche es nach der in Retry-After angegebenen Anzahl Sekunden erneut. Während Wartungsarbeiten ist der Body reiner Text statt des Fehlerumschlags.

5XXapplication/json

Die Anfrage wurde abgelehnt. code nennt den Grund, und error beschreibt ihn in Worten.

codestringerforderlich

Warum die Anfrage abgelehnt wurde, als stabiler Code, nach dem du verzweigen kannst: zum Beispiel insufficient_scope (403), rate_limited (429) und, bei einem nutzungsbasiert abgerechneten Client, spend_cap_reached (402) und metered_billing_inactive (402).

errorstringerforderlich

Beispiel

curl "https://api.getlingara.com/v1/events" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

Lieber eine Bibliothek? Siehe den Bereich Bibliotheken.