Orodhesha matukio

Vigezo

Lingara-Versionheaderstringsi lazima

Toleo la API la kutumia kujibu ombi hili. Bila hilo, tokeni ya ufikiaji hupata toleo ambalo mteja wake ameunganishwa nalo, na ombi lisilo na tokeni hupata toleo la sasa. Toleo ambalo bado linaendelezwa linafikiwa tu kwa kulitaja hapa. Toleo lisilojulikana hujibiwa 400 pamoja na msimbo api_version_unknown. GET /v1/versions huorodhesha matoleo.

cursorquerystringsi lazima

Mahali pa kuendelea: next_cursor ya ukurasa wa awali, au id: ya tukio la mtiririko. Kiashiria cha zaidi ya siku 30 hujibiwa 410 na msimbo cursor_expired.

startquerystringsi lazima

Mahali pa kuanzia bila kiashiria: latest kwa matukio kuanzia sasa, au oldest kwa kila tukio ambalo bado limehifadhiwa.

typesqueryarray of stringsi lazima

Aina hizi za matukio pekee, zikitenganishwa kwa koma. Bila hiki, kila aina ambayo mawanda ya tokeni yako yanaweza kusoma.

limitqueryintegersi lazima

Idadi kubwa zaidi ya matukio ambayo ukurasa mmoja hurejesha, kuanzia 1 hadi 100.

Majibu

200 Ukurasa wa matukio na kiashiria cha kuendelea

itemsarray of EventEnvelopeinahitajika

idstringinahitajika

typestringinahitajika

created_atstringinahitajika

api_versionstringinahitajika

subjectstringinahitajika

dataobjectinahitajika

next_cursorstringinahitajika

has_morebooleaninahitajika

Hitilafu

410application/json

api_version_discontinued: toleo la API la ombi hili limesitishwa. cursor_expired: kiashiria kina zaidi ya siku 30; anza upya bila hicho.

4XXapplication/json

Ombi limekataliwa. code inaeleza sababu, na error inaieleza kwa maneno.

503application/json · text/plain

Huduma haipatikani kwa muda; jaribu tena baada ya idadi ya sekunde zilizo katika Retry-After. Wakati wa matengenezo, mwili wa jibu ni maandishi ya kawaida badala ya bahasha ya hitilafu.

5XXapplication/json

Ombi limekataliwa. code inaeleza sababu, na error inaieleza kwa maneno.

codestringinahitajika

Sababu ya ombi kukataliwa, kama msimbo thabiti wa kufanyia maamuzi: kwa mfano insufficient_scope (403), rate_limited (429) na, kwa mteja anayetozwa kwa matumizi, spend_cap_reached (402) na metered_billing_inactive (402).

errorstringinahitajika

Mfano

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

Unapendelea maktaba? Tazama sehemu ya Maktaba.