Daftar peristiwa

Parameter

Lingara-Versionheaderstringopsional

Versi API yang digunakan untuk menjawab permintaan ini. Tanpanya, token akses mendapatkan versi yang disematkan pada kliennya, dan permintaan tanpa token mendapatkan versi saat ini. Versi yang masih dalam pengembangan hanya dapat dicapai dengan menyebutkannya di sini. Versi yang tidak dikenal dijawab 400 dengan kode api_version_unknown. GET /v1/versions mencantumkan versi-versinya.

cursorquerystringopsional

Dari mana melanjutkan: next_cursor dari halaman sebelumnya, atau id: dari peristiwa stream. Kursor yang lebih tua dari 30 hari dijawab 410 dengan kode cursor_expired.

startquerystringopsional

Tempat memulai tanpa kursor: latest untuk peristiwa mulai sekarang, atau oldest untuk setiap peristiwa yang masih disimpan.

typesqueryarray of stringopsional

Hanya jenis peristiwa ini, dipisahkan koma. Tanpanya, setiap jenis yang dapat dibaca oleh cakupan token Anda.

limitqueryintegeropsional

Jumlah peristiwa terbanyak yang dikembalikan satu halaman, dari 1 hingga 100.

Respons

200 Satu halaman peristiwa dan kursor untuk melanjutkan

itemsarray of EventEnvelopewajib

idstringwajib

typestringwajib

created_atstringwajib

api_versionstringwajib

subjectstringwajib

dataobjectwajib

next_cursorstringwajib

has_morebooleanwajib

Galat

410application/json

api_version_discontinued: versi API permintaan ini telah dihentikan. cursor_expired: kursor lebih tua dari 30 hari; mulai lagi tanpa kursor.

4XXapplication/json

Permintaan ditolak. code menyebutkan alasannya, dan error menjelaskannya dengan kata-kata.

503application/json · text/plain

Layanan sementara tidak tersedia; coba lagi setelah jumlah detik di Retry-After. Selama pemeliharaan, isi respons berupa teks biasa, bukan amplop galat.

5XXapplication/json

Permintaan ditolak. code menyebutkan alasannya, dan error menjelaskannya dengan kata-kata.

codestringwajib

Alasan permintaan ditolak, sebagai kode tetap untuk percabangan: misalnya insufficient_scope (403), rate_limited (429) dan, untuk klien dengan penagihan per pemakaian, spend_cap_reached (402) dan metered_billing_inactive (402).

errorstringwajib

Contoh

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

Lebih suka pustaka? Lihat bagian Pustaka.