API リファレンス

プロジェクトイベント API

耐久プロジェクトイベント

HTTP リファレンス。 バックエンド契約から生成。以下のエンドポイントを参照するか、OpenAPI をダウンロードしてください。

このグループには 2 件のオペレーションがあり、api/openapi.yaml から生成されています。パス、アクション、認証で絞り込めます。各エンドポイントには入力が一覧され、展開するとリクエストテンプレートとレスポンスコードを確認できます。テンプレートには、ご自身の値とスキーマに適合する本文が必要です。

大文字のプレースホルダーをあなたの値に置き換えます。JSONリクエストの場合、request.jsonのスキーマに合うボディを保存します。Cookie例は認証済みセッションのローカルCookieジャーを使用します。

耐久プロジェクトイベント

GET/api/events

イベント一覧

耐久性のあるプロジェクトイベントをシーケンス順に一覧表示

ページングは連続しています:返されたnext_cursorをafterとして渡し、ページが停止した正確な位置から続行します。next_cursorは最後に返されたイベントのカーソルで、新しいイベントがすでに存在し、履歴の終わりではnullです。limitはデフォルト50で1〜200を受け入れ、それ以外はinvalid_requestでlimitを指定するerrors[]メンバーを返します。

オフセットページングはサポートされていません。source=logは代わりにPlayerログをリストします:条件レポートは受信時間昇順で(runtime.reported)、screen_idと重大度でフィルタし、期間はデフォルトで過去24時間、最大31日です。

カーソルは不透明です:サーバーがプレーヤーログを保持する場所によりlg1_またはev1_です。ページが返したものを返してください。別種のカーソルはinvalid_requestでフィールド名付きで拒否されます。プレーヤーログ記録はシーケンスを持たず、GET /stream/projectに含まれず、Webhookに配信されません。

レコードはPlayerログキューが受け入れ、プロジェクトのイベント保持に保存されると承認されます。最後のカーソルとデフォルトウィンドウでポーリングが続きます。Playerログレコードはデフォルト(source=project)リストには含まれません。fromとtoはsourceがlogでない限りinvalid_requestで拒否されます。

プロジェクトリストはscreen_id、playlist_id、application_idを受け取り、1つのスクリーン、プレイリスト、またはアプリケーションのイベントを読み取ります。すべて認証情報のプロジェクトにスコープされます(idはどのイベントを読むかを示し、誰のかは示しません):screen_idはそのスクリーンをリソースとするイベント、playlist_idはそのプレイリストをリソースとするイベントとdetails.playlist_id(それを取るスクリーン)を名前に持つイベント、application_idはそのアプリケーションをリソースとするイベントとapplication_idをリソースに持つイベント(リリースやキー/バリューエントリ)です。

種類のIDでない値はフィールド名を指定して invalid_request で拒否されます。playlist_id と application_id は source=log で拒否されます。ログはスクリーンにのみ属します。

両方のソースは resource_id、type、severity(最低限)を取り、それらを組み合わせ、IDフィルターとページングと組み合わせます。Playerログレコードは、resource がそのスクリーンである runtime.reported レコードです。したがって、そのスクリーンでない resource_id または runtime.reported を除外する type は空のページを返します。before(または order=desc)は最新を先にページングし、next_cursor は返された最も古い項目のカーソルで、before として渡されるとより古い項目に進みます。

fromなしの最新優先source=logページはデフォルトの24時間を超え、プロジェクトのイベント保持が保持する最古記録まで遡ります。1リクエストあたり最大31日間。最新優先source=logページはlimit未満または0件のレコードを含み、next_cursorを持つことがあります。nullは保持ログの終わりで終了します。

スクリーンに限定された呼び出し元(docs/screen-scope.md)は、フィルターされたフィードを読み取ります。対象は、スコープ内のスクリーンのイベント、見ることができるスクリーンフォルダー(自身のフォルダー、その上位と内側のフォルダー。screen.moved は移動先がスコープ内にある場合のみ)のイベント、キャンペーン、プレイリスト、メディア、アプリケーション、カードのイベント、および playlist_change レビューです。

それ以外のイベントはすべて除外されるため、ページに含まれるイベントは limit より少なくなることがあり、next_cursor があっても0件になることさえあります。next_cursor でページ送りを続けてください。source=log にはスコープ内の screen_id が必要です。プロジェクト自体に関するイベントは送信されません。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
listEvents

パラメーター

名前送信する必須?説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
以降クエリオプション

前回の応答からのカーソル:プロジェクトイベント(およびイベントストリーム)用の ev1_。プレーヤーログ(source=log)はサーバーが保持する場所で lg1_ または ev1_ カーソルでページングします。これらは不透明として扱い、ページが返したものを返します。別種のカーソルは invalid_request で拒否されます。

beforeクエリオプション

ページは新しい順で、このカーソルより厳密に古いものです:新しい順ページのnext_cursor、または任意のアイテムカーソル(ev1_はプロジェクトイベント用、source=logはアイテムが持つ不透明カーソル)。order=descで空またはなしは最新アイテムから開始します。

順序クエリオプションasc は after 付きで古い順のページング。desc は before 付きで新しい順。before は desc を意味し、order=asc と before の組み合わせは拒否されます。
制限クエリオプションページサイズ。1〜200の範囲外の値はinvalid_requestで拒否され、フィールドがlimitのerrors[]メンバーが返されます。
ソースクエリオプションプロジェクトは連続したプロジェクトイベントを一覧表示します。ログはプレーヤーログ:プレーヤー状態レポート(runtime.reported)を受信時間順に表示します。
resource_idクエリオプションresource.id がこのID(スクリーン、playlist、media、webhook、agent、application ID)のアイテムのみ。source=log の場合は記録のスクリーンです。
タイプクエリオプションplaylist.updated のような正確なイベントタイプ、または playlist.* のすべてにマッチする playlist. で終わるファミリープレフィックス。
screen_idクエリオプションこのスクリーンのイベントのみ:source=project ではリソースがスクリーンのもの、source=log ではPlayerログ記録。別のID種別は invalid_request で拒否されます。
playlist_idクエリオプションsource=projectの場合、このplaylistのイベントのみ:リソースがplaylistのものと、details.playlist_idとして指定するもの。source=logは拒否されます。
application_idクエリオプション

source=projectの場合、このアプリケーションのイベントのみ:リソースがアプリケーションのものと、application_idとして持つもの(リリースやキー/バリューエントリ)。source=logは拒否されます。

重大度クエリオプション最小の重大度:info はすべての項目、warning は警告とエラー、error はエラーのみ。両方のソース。
開始クエリオプションsource=logの場合、ウィンドウの開始(包含)。デフォルトはtoの24時間前。fromなしの最新優先ページはプロジェクトのイベント保持期間まで遡ります。
からクエリオプションsource=logの場合、ウィンドウの終了(排他)。デフォルトは現在時刻。ウィンドウは最大31日間です。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/events'

レスポンス

ステータス意味本文とヘッダー
200耐久イベント(source=project)またはプレーヤーログ記録(source=log)EventList (application/json)
403

outside_screen_scope - 呼び出し元がスクリーンに限定されており、リクエストが指定する、または及ぶスクリーン、スクリーンフォルダー、セレクター、対象がその範囲外です(docs/screen-scope.md)。スコープ外のIDと存在しないIDには同じ応答が返されます。errors[0].screen_scope には呼び出し元のスコープが含まれ、書き込みは絞り込まれることなく全体が拒否されます。

問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/stream/project

ストリームイベント

リプレイ可能なプロジェクトのリッスンストリーム。プレーヤーのログレコード(runtime.reported)は GET /api/events?source=log で読み取り、このストリームには含まれません。このリクエストを開くと、リッスン購読として1クレジットかかります。クレジットヘッダーは省略されます。以降の課金対象イベントは1件につき1クレジットです。screen.*、runtime.*、alert_mute.*、application.event は免除されます。

ハートビートとリトライ前文は課金されません。stream.cursor と stream.resync_required は課金対象です。デビットの冪等性は sse-event:<project_id>:<sequence> であり、再接続再生は無料です。未払いの課金イベントは書き込まれず、ストリームは閉じます。

ダッシュボードセッションで開いたストリームは、ダッシュボードのAPIリクエストと同様に、課金されません(開始もそのイベントも)。ただし、プロジェクトのストリームスロットを1つ使用します。スクリーンに限定された呼び出し元(docs/screen-scope.md)は GET /api/events と同じフィルターされたフィードを受け取ります。破棄されたイベントのフレームは送信されず、stream.cursor は位置を進め続けます。

スコープはストリームが開かれるときに読み取られ、移動またはフォルダーイベントのときにフォルダーツリーが再び読み取られます。絞り込まれたスコープは、開いているストリームに、再接続時に適用されます。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
streamEvents

パラメーター

名前送信する必須?説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
以降クエリオプション

前回の応答からのカーソル:プロジェクトイベント(およびイベントストリーム)用の ev1_。プレーヤーログ(source=log)はサーバーが保持する場所で lg1_ または ev1_ カーソルでページングします。これらは不透明として扱い、ページが返したものを返します。別種のカーソルは invalid_request で拒否されます。

Last-Event-IDヘッダーオプションafterがない場合に使用される耐久カーソル。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/stream/project'

レスポンス

ステータス意味本文とヘッダー
200

再生可能なSSEストリーム。クエリーカーソルはLast-Event-IDより優先されます。無効、未来、保持期間外のカーソルはstream.resync_requiredを現在の先頭で受け取り閉じます。ScreenRig-Credits-*ヘッダーはありません。

string (text/event-stream)
402

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)