Gebeurtenissen weergeven

Parameters

Lingara-Versionheaderstringoptioneel

De API-versie waaronder dit verzoek wordt beantwoord. Zonder deze krijgt een toegangstoken de versie waaraan zijn client is gekoppeld, en een verzoek zonder token de huidige versie. De versie die nog in ontwikkeling is, bereik je alleen door die hier te noemen. Een onbekende versie geeft 400 met code api_version_unknown. GET /v1/versions toont de versies.

cursorquerystringoptioneel

Waar je verdergaat: de next_cursor van een eerdere pagina, of de id: van een streamgebeurtenis. Een cursor ouder dan 30 dagen krijgt 410 met code cursor_expired.

startquerystringoptioneel

Waar je begint zonder cursor: latest voor gebeurtenissen vanaf nu, of oldest voor elke gebeurtenis die nog bewaard wordt.

typesqueryarray of stringoptioneel

Alleen deze gebeurtenistypen, gescheiden door komma's. Zonder deze parameter elk type dat de scopes van je token mogen lezen.

limitqueryintegeroptioneel

Het maximale aantal gebeurtenissen per pagina, van 1 tot 100.

Antwoorden

200 Een pagina gebeurtenissen en de cursor om verder te gaan

itemsarray of EventEnvelopeverplicht

idstringverplicht

typestringverplicht

created_atstringverplicht

api_versionstringverplicht

subjectstringverplicht

dataobjectverplicht

next_cursorstringverplicht

has_morebooleanverplicht

Fouten

410application/json

api_version_discontinued: de API-versie van dit verzoek is stopgezet. cursor_expired: de cursor is ouder dan 30 dagen; begin opnieuw zonder cursor.

4XXapplication/json

Het verzoek is geweigerd. code geeft de reden aan en error beschrijft die in woorden.

503application/json · text/plain

De dienst is tijdelijk niet beschikbaar; probeer het opnieuw na het aantal seconden in Retry-After. Tijdens onderhoud is de body platte tekst in plaats van de foutenvelop.

5XXapplication/json

Het verzoek is geweigerd. code geeft de reden aan en error beschrijft die in woorden.

codestringverplicht

Waarom het verzoek is geweigerd, als stabiele code om op te vertakken: bijvoorbeeld insufficient_scope (403), rate_limited (429) en, voor een client met verbruiksafrekening, spend_cap_reached (402) en metered_billing_inactive (402).

errorstringverplicht

Voorbeeld

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

Liever een bibliotheek? Zie de sectie Bibliotheken.