Session の公開イベントを一覧取得します。
GET /api/v1/cloud/sessions/{session_id}/events
カーソルページネーションで Session の公開イベントを取得します。Accept ヘッダーで text/event-stream を要求した場合、このルートは SSE ストリーミングに切り替わります。ページネーションされた JSON レスポンスを得るには Accept: application/json を指定するか、SSE のメディアタイプを省略してください。
パスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
session_id | string | sess_ プレフィックス付きの Session ID |
ヘッダー
| ヘッダー | 必須 | 説明 |
|---|---|---|
Authorization | はい | Bearer $QODER_ACCESS_TOKEN |
クエリパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
limit | integer | いいえ | 返すイベントの最大数。デフォルトは 20、範囲は 1〜100。100 を超える値は 400 invalid_request_error を返します。 |
page | string | いいえ | 前回のレスポンスの next_page から得られる不透明なカーソル。before_id および after_id とは排他的です |
before_id | string | いいえ | このイベント ID より前の順序のイベントを返します。page および after_id とは排他的です |
after_id | string | いいえ | このイベント ID より後の順序のイベントを返します。page および before_id とは排他的です |
order | string | いいえ | ソート方向: asc(デフォルト)または desc |
types | string または array | いいえ | イベントタイプでフィルタします。認識されないイベントタイプは無視され、レスポンスには一致するイベントが含まれないだけです |
created_at[gt] | string | いいえ | この RFC 3339 タイムスタンプより後に作成されたイベントを返します |
created_at[gte] | string | いいえ | この RFC 3339 タイムスタンプ以降に作成されたイベントを返します |
created_at[lt] | string | いいえ | この RFC 3339 タイムスタンプより前に作成されたイベントを返します |
created_at[lte] | string | いいえ | この RFC 3339 タイムスタンプ以前に作成されたイベントを返します |
リクエスト例
レスポンス例
HTTP 200 OK
イベントタイプ
list および stream エンドポイントが公開するイベントタイプの全一覧は 公開イベントタイプ を参照してください。
レスポンスフィールド
| フィールド | 型 | 説明 |
|---|---|---|
data | array | 公開 Event オブジェクト のリスト |
has_more | boolean | このページの先にさらに結果があるかどうか |
first_id | string | null | 現在のページの最初のイベントの ID |
last_id | string | null | 現在のページの最後のイベントの ID |
next_page | string | null | 次ページの不透明なカーソル。結果がそれ以上ない場合は null |
エラー
| HTTP | タイプ | トリガー条件 |
|---|---|---|
| 400 | invalid_request_error | 不正な limit(非整数または非正値)、不正な order、不正なタイムスタンプフィルタ、または page と before_id/after_id の同時指定 |
| 401 | authentication_error | PAT または SAT が無効または期限切れ |
not_found_error | Session が存在しません。エラーメッセージは Session '<session_id>' was not found. |