イベントを一覧表示

パラメーター

Lingara-Versionheaderstring任意

このリクエストに応答する API バージョン。指定がない場合、アクセストークンはそのクライアントに固定されたバージョンを、トークンのないリクエストは現行バージョンを受け取ります。開発中のバージョンには、ここで指定した場合にのみアクセスできます。不明なバージョンにはコード api_version_unknown とともに 400 を返します。GET /v1/versions でバージョンを一覧できます。

cursorquerystring任意

続きの位置：前のページの next_cursor、またはストリームのイベントの id:。30 日より古いカーソルには 410（コード cursor_expired）を返します。

startquerystring任意

カーソルなしで開始する位置：今後のイベントには latest、保持中のすべてのイベントには oldest。

typesqueryarray of string任意

これらのイベントタイプのみ（カンマ区切り）。省略すると、トークンのスコープで読み取れるすべてのタイプ。

limitqueryinteger任意

1 ページで返すイベントの最大数（1〜100）。

レスポンス

200 イベントの 1 ページと、続きを取得するためのカーソル

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"

ライブラリを使いたい場合は、ライブラリのセクションをご覧ください。