列出事件

參數

Lingara-Versionheaderstring選填

回應此要求所用的 API 版本。未提供時，存取權杖使用其用戶端綁定的版本，不帶權杖的要求使用目前版本。仍在開發中的版本只能透過在此指定來存取。未知版本會以 400 回應，代碼為 api_version_unknown。GET /v1/versions 會列出所有版本。

cursorquerystring選填

從哪裡繼續：上一頁的 next_cursor，或串流中某個事件的 id:。超過 30 天的游標會回應 410，代碼為 cursor_expired。

startquerystring選填

沒有游標時從哪裡開始：latest 表示從現在起的事件，oldest 表示仍保留的所有事件。

typesqueryarray of string選填

僅這些事件類型，以逗號分隔。省略時，為你的權杖範圍可以讀取的所有類型。

limitqueryinteger選填

一頁最多傳回的事件數，從 1 到 100。

回應

200 一頁事件，以及用於繼續的游標

itemsarray of EventEnvelope必填

idstring必填

typestring必填

created_atstring必填

api_versionstring必填

subjectstring必填

dataobject必填

next_cursorstring必填

has_moreboolean必填

錯誤

410application/json

api_version_discontinued：此請求的 API 版本已停用。cursor_expired：游標已超過 30 天；請不帶游標重新開始。

4XXapplication/json

要求遭到拒絕。code 說明原因，error 以文字描述原因。

503application/json · text/plain

服務暫時無法使用；請在 Retry-After 所示的秒數之後重試。維護期間，回應內文為純文字，而非錯誤封包。

5XXapplication/json

要求遭到拒絕。code 說明原因，error 以文字描述原因。

codestring必填

請求被拒絕的原因，以穩定的代碼表示，可據此進行分支處理：例如 insufficient_scope（403）、rate_limited（429），以及按用量計費的用戶端的 spend_cap_reached（402）和 metered_billing_inactive（402）。

errorstring必填

範例

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

想用函式庫？請參閱「函式庫」一節。