Listaa tapahtumat

Parametrit

Lingara-Versionheaderstringvalinnainen

API-versio, jolla tähän pyyntöön vastataan. Ilman sitä käyttötunnus saa version, johon sen asiakas on kiinnitetty, ja pyyntö ilman tunnusta saa nykyisen version. Vielä kehitteillä olevaan versioon pääsee vain nimeämällä sen tässä. Tuntemattomaan versioon vastataan 400 koodilla api_version_unknown. GET /v1/versions luettelee versiot.

cursorquerystringvalinnainen

Mistä jatketaan: aiemman sivun next_cursor tai virran tapahtuman id:. Yli 30 päivää vanhaan kohdistimeen vastataan 410 koodilla cursor_expired.

startquerystringvalinnainen

Mistä aloitetaan ilman kohdistinta: latest tapahtumille tästä eteenpäin tai oldest jokaiselle vielä säilytetylle tapahtumalle.

typesqueryarray of stringvalinnainen

Vain nämä tapahtumatyypit pilkuilla eroteltuina. Ilman sitä jokainen tyyppi, jonka tunnuksesi oikeudet voivat lukea.

limitqueryintegervalinnainen

Enimmäismäärä tapahtumia yhdellä sivulla, 1–100.

Vastaukset

200 Sivu tapahtumia ja kohdistin, josta jatkaa

itemsarray of EventEnvelopepakollinen

idstringpakollinen

typestringpakollinen

created_atstringpakollinen

api_versionstringpakollinen

subjectstringpakollinen

dataobjectpakollinen

next_cursorstringpakollinen

has_morebooleanpakollinen

Virheet

410application/json

api_version_discontinued: tämän pyynnön API-versio on lopetettu. cursor_expired: kohdistin on yli 30 päivää vanha; aloita alusta ilman sitä.

4XXapplication/json

Pyyntö hylättiin. code kertoo syyn, ja error kertoo sen sanoin.

503application/json · text/plain

Palvelu ei ole tilapäisesti käytettävissä; yritä uudelleen Retry-After-otsakkeen ilmoittaman sekuntimäärän jälkeen. Huoltokatkon aikana runko on pelkkää tekstiä virhekehyksen sijaan.

5XXapplication/json

Pyyntö hylättiin. code kertoo syyn, ja error kertoo sen sanoin.

codestringpakollinen

Miksi pyyntö hylättiin, pysyvänä koodina, jonka mukaan voit haarautua: esimerkiksi insufficient_scope (403), rate_limited (429) ja käytön mukaan laskutettavalle asiakkaalle spend_cap_reached (402) ja metered_billing_inactive (402).

errorstringpakollinen

Esimerkki

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

Käytätkö mieluummin kirjastoa? Katso Kirjastot-osio.