Liệt kê sự kiện

Tham số

Lingara-Versionheaderstringtùy chọn

Phiên bản API dùng để trả lời yêu cầu này. Nếu không có, token truy cập nhận phiên bản mà ứng dụng khách của nó được gắn, còn yêu cầu không có token nhận phiên bản hiện tại. Phiên bản đang phát triển chỉ có thể dùng bằng cách nêu tên nó ở đây. Phiên bản không xác định được trả lời bằng 400 với mã api_version_unknown. GET /v1/versions liệt kê các phiên bản.

cursorquerystringtùy chọn

Vị trí tiếp tục: next_cursor của một trang trước, hoặc id: của một sự kiện trong luồng. Con trỏ cũ hơn 30 ngày nhận phản hồi 410 với mã cursor_expired.

startquerystringtùy chọn

Vị trí bắt đầu khi không có con trỏ: latest cho các sự kiện từ bây giờ, hoặc oldest cho mọi sự kiện vẫn còn được lưu.

typesqueryarray of stringtùy chọn

Chỉ các loại sự kiện này, phân tách bằng dấu phẩy. Nếu không có, mọi loại mà phạm vi của token có thể đọc.

limitqueryintegertùy chọn

Số sự kiện tối đa một trang trả về, từ 1 đến 100.

Phản hồi

200 Một trang sự kiện và con trỏ để tiếp tục

itemsarray of EventEnvelopebắt buộc

idstringbắt buộc

typestringbắt buộc

created_atstringbắt buộc

api_versionstringbắt buộc

subjectstringbắt buộc

dataobjectbắt buộc

next_cursorstringbắt buộc

has_morebooleanbắt buộc

Lỗi

410application/json

api_version_discontinued: phiên bản API của yêu cầu này đã ngừng hoạt động. cursor_expired: con trỏ cũ hơn 30 ngày; hãy bắt đầu lại mà không dùng con trỏ.

4XXapplication/json

Yêu cầu đã bị từ chối. code cho biết lý do, và error diễn đạt lý do đó bằng lời.

503application/json · text/plain

Dịch vụ tạm thời không khả dụng; hãy thử lại sau số giây ghi trong Retry-After. Trong thời gian bảo trì, phần thân là văn bản thuần thay vì phong bì lỗi.

5XXapplication/json

Yêu cầu đã bị từ chối. code cho biết lý do, và error diễn đạt lý do đó bằng lời.

codestringbắt buộc

Lý do yêu cầu bị từ chối, dưới dạng một mã ổn định để rẽ nhánh: ví dụ insufficient_scope (403), rate_limited (429) và, với ứng dụng khách tính phí theo mức dùng, spend_cap_reached (402) và metered_billing_inactive (402).

errorstringbắt buộc

Ví dụ

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

Muốn dùng thư viện? Xem mục Thư viện.