OpenAPI YAMLOpenAPI JSON問題 YAMLAPI の概要
このグループには 4 件のオペレーションがあり、api/openapi.yaml から生成されています。パス、アクション、認証で絞り込めます。各エンドポイントには入力が一覧され、展開するとリクエストテンプレートとレスポンスコードを確認できます。テンプレートには、ご自身の値とスキーマに適合する本文が必要です。
大文字のプレースホルダーをあなたの値に置き換えます。JSONリクエストの場合、request.jsonのスキーマに合うボディを保存します。Cookie例は認証済みセッションのローカルCookieジャーを使用します。
再生集計
再生集計一覧
毎日の再生集計。
JSONは最大200行を返し、レート制限はありません。format=csv(またはAccept text/csvでapplication/jsonなし)はday_fromからday_toまでの一致する行をすべてCSVでストリームし、固定ヘッダー行(PlaybackAggregateCsv)付きです。day_toはデフォルトで今日、day_fromは30日前、最大366日、それ以外はinvalid_requestです。CSV形式のみplayback-export-org(1分あたり30)とplayback-export-ip(1分あたり60)の予算を消費します。
どちらの形式も、計測される API リクエスト1回です。レスポンスには Vary Accept が付きます。スクリーンに限定された呼び出し元(docs/screen-scope.md)は screen_id を送信する必要があり、それはスコープ内のスクリーンでなければなりません(そうでない場合は outside_screen_scope)。CSV形式にも同じルールが適用されます。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| screen_id | クエリ | オプション | |
| media_id | クエリ | オプション | |
| 日 | クエリ | オプション | 集計のUTC暦日。 |
| day_from | クエリ | オプション | 最初の UTC 日(含む)。day は除外。day_to と合わせて最大 366 日。CSV では day_to の 30 日前がデフォルト。 |
| day_to | クエリ | オプション | 最終UTC日(含む)。日を除く。CSVはデフォルトで今日(UTC)。 |
| フォーマット | クエリ | オプション | json(既定)、csv、xlsx、pdf。省略した場合、text/csv を指定し application/json を指定しない Accept ヘッダーは csv を選びます。xlsx と pdf は同じ一覧の最初の 50000 行を書き出します。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playback'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 呼び出し元プロジェクトの毎日の再生集計です。画像と動画の両方を含みます。スクリーン、メディア、UTCの日ごとに1行ずつ表示し、新しい日付が先に来ます。識別子は呼び出し元の自身の行をフィルターし、プロジェクト間の参照は行いません。 | PlaybackAggregateList(application/json)、PlaybackAggregateCsv(text/csv);ヘッダー:Vary、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
再生プレイ一覧
再生ごとの記録:呼び出しプロジェクトの受理されたplayback.media_started(またはレガシーplayback.video_started)ごとに1行、受理されたplayback.application_started(release_idセット、メディアフィールドは空)ごとに1行、最古順にreceived_atで、同順位は挿入順。from(含む)とto(除く)はreceived_atを境界とし、toはデフォルトで現在、fromはtoの24時間前、範囲は最大31日(そうでなければinvalid_request)。
最新の5秒はまだ返されません:有効な終了時刻は最大で現在時刻から5秒引いたもの(遅延解消)です。ライブテイルはカーソルの後ろでコミットされた行をスキップしません。screen_id、media_id、playlist_id(開始が表示されたplaylist)、タグ(再生受信時のスクリーンタグ)でフィルターします。
playlist_idページは制限行数未満、またはゼロの場合もあります。長期間他のプレイリストの再生がスキャンされた場合はnext_cursor。nullは範囲の終了を示します。
JSONは最大limit行(デフォルト200、最大1000)のページでnext_cursorを持ち、範囲の終わりでnullです。同じフィルターでカーソルとして返してください。order=desc(またはbefore)は同じ範囲内で最新を先にページングし、next_cursorは返された最古行のカーソルで範囲の開始でnull、before(排他)として同じフィルターで返します。order=ascとbeforeはinvalid_requestでorder名付きで拒否され、最新優先ページのカーソルはcursor名付きで拒否されます。
最新順ページは、制限行数未満、またはゼロの場合もあり、next_cursor を含みます。null は終了を示します。
後のページは、前のページで存在した行をスキップせず、繰り返しもしません。ただし、未確認レポート後にPlayerが再送した開始(同じplay_id、直後に受信)は後のページに再度現れることがあります。CSVストリームは範囲のカーソルから末尾までのすべての再生をCSV(PlaybackPlayCsv)で新しい順にリストします。format=csv(またはapplication/jsonなしのAccept text/csv)はCSVでストリームし、limitは拒否されます。
メータリングはリクエストごとです:各 JSON ページは API リクエストクレジットを1つ消費し、範囲全体の CSV ストリームは1つ消費します。すべての再生リクエスト(ページまたはストリーム)は playback-export-org(1分あたり30)と playback-export-ip(1分あたり60)の予算を消費します。
ストリームは各書き込みを15秒で区切り、クライアント切断で終了します。200ヘッダー後に失敗すると接続は中止されるため、正常終了まで読み取ったエクスポートは完了です。レスポンスは Vary Accept を含みます。再生はプランのイベント保持期間(出荷時は30日、プランベースは7日または90日)で保持されます。
スクリーンに限定された呼び出し元(docs/screen-scope.md)は screen_id を送信する必要があり、それはスコープ内のスクリーンでなければなりません(そうでない場合は outside_screen_scope)。CSV形式にも同じルールが適用されます。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| 開始 | クエリ | オプション | received_at の包括的下限。デフォルトは to の24時間前。 |
| から | クエリ | オプション | received_at の排他的上限。デフォルトは現在。to - from は最大31日。 |
| screen_id | クエリ | オプション | |
| media_id | クエリ | オプション | |
| playlist_id | クエリ | オプション | このplaylistで表示された再生のみ。 |
| タグ | クエリ | オプション | 再生受信時にスクリーンが持っていたタグ。 |
| カーソル | クエリ | オプション | 前のページの next_cursor。同じフィルター付き。不透明。 |
| 順序 | クエリ | オプション | asc はカーソル付きで古い順のページング。desc は before 付きで新しい順。before は desc を意味し、order=asc と before の組み合わせは拒否されます。 |
| before | クエリ | オプション | ページは新しい順で、この位置より厳密に古いものです:同じフィルターの新しい順ページのnext_cursor。不透明です。 |
| 制限 | クエリ | オプション | JSONページサイズ。CSVで拒否されます。 |
| フォーマット | クエリ | オプション | json(既定)、csv、xlsx、pdf。省略した場合、text/csv を指定し application/json を指定しない Accept ヘッダーは csv を選びます。xlsx と pdf は同じ一覧の最初の 50000 行を書き出します。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playback/plays'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 再生のページ、または CSV ストリーム。 | PlaybackPlayList(application/json)、PlaybackPlayCsv(text/csv);ヘッダー:Cache-Control、Vary、RateLimit-Policy、RateLimit |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 429 | 安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。 | 問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
再生合計を取得
呼び出しプロジェクトのUTC日単位の再生合計。日別集計から読み込み:by=dayは日ごと1行(screen_idまたはmedia_idで1スクリーンまたは1メディアに絞り込み)、by=screenとby=mediaは最も多いスクリーンまたはメディアをランク付け(最大100)、by=screen_dayはトップスクリーンの日系列(最大10)。day_toは今日(UTC)デフォルト、day_fromは29日前。
日系列は最大366日(スクリーンまたはメディアに絞ると92日)、ランキングは最大92です。カウントにはプレイロールアップが存在する前に記録された開始も含まれます。
ロールアップは取り込み後最大約21分遅れます。truncated が true の場合は、ウィンドウのスライスが1回の読み取りに大きすぎてランキングが構築されたことを示します:各スライスの最良キーをカバーします。レート制限なし。1回のメーター付きAPIリクエスト。
スクリーンに限定された呼び出し元(docs/screen-scope.md)は screen_id を送信する必要があり、それはスコープ内のスクリーンでなければなりません(そうでない場合は outside_screen_scope)。CSV形式にも同じルールが適用されます。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| フォーマット | クエリ | オプション | json(既定)はレポートを JSON で返します。csv、xlsx、pdf は同じ行を添付ファイルとして返します(ページ分割されたレポートは全ページ、最大 50000 行)。 |
| by | クエリ | オプション | day:1日の再生回数。screen、media:最も多いキー。screen_day:トップスクリーンの日別シリーズ。 |
| day_from | クエリ | オプション | 最初の UTC 日(含む)。day_to の 29 日前がデフォルトです。日シリーズは最大 366 日(スクリーンまたはメディアに絞ると 92 日)、ランキングは最大 92 日です。 |
| day_to | クエリ | オプション | 最終UTC日(含む)。デフォルトは今日(UTC)。 |
| screen_id | クエリ | オプション | |
| media_id | クエリ | オプション | |
| 上部 | クエリ | オプション | ランキングが返すスクリーンまたはメディアの数(by=screen_dayの場合最大10)。by=dayでは拒否されます。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playback/totals'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 要求されたグループの合計。 | PlaybackTotals(application/json);ヘッダー:Cache-Control |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+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) |
再生の完全性を取得
スクリーンが行った再生のうち、バックエンドに届いた数と、届かなかった再生の場所を示します。プレーヤーはメディアの再生開始に番号を付けるため、届かなかった開始があると番号に欠番が生じます。たとえば、スクリーンが24時間のレポートキューを超えてオフラインのままだった場合や、キューがレポートを破棄した場合です。
day_from から day_to まで(両端を含む)の UTC の日について、応答には次の値が含まれます。day_to のデフォルトは UTC の今日、day_from のデフォルトはその29日前で、期間は最大92日です。measured_plays は届いた番号付きの再生の数、missing_plays はプレーヤーが飛ばした番号の数、completeness は measured_plays を両者の合計で割った値(両方が 0 の場合は null)、days は該当する日ごとの同じ3つの値(古い順で、欠番はその直後の再生の UTC 日に数えます)、gaps は欠番を新しい順に並べたもので、それぞれ screen_id、day、from と to(欠番の前後にある再生の開始時刻)、missing_plays を持ちます。screen_id を指定すると days と gaps が1つのスクリーンに絞り込まれます。limit(デフォルト100件、最大500件)は gaps の件数を制限し、さらにある場合は truncated が true になります。
オフになっているスクリーンは再生を行わず、欠番も生じません。番号のない再生(古いプレーヤー、再生番号の導入前に保存された再生開始)は計測されません。これらは GET /api/playback/totals の play_count には含まれますが、ここに示す数値のいずれにも含まれません。レート制限はありません。従量課金の API リクエスト1件として計上されます。
スクリーンに限定された呼び出し元(docs/screen-scope.md)は screen_id を送信する必要があり、それはスコープ内のスクリーンでなければなりません(そうでない場合は outside_screen_scope)。CSV形式にも同じルールが適用されます。
パラメーター
| 名前 | 送信する | 必須? | 説明 |
|---|---|---|---|
| ScreenRig-Project | ヘッダー | オプション | 1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。 |
| フォーマット | クエリ | オプション | json(既定)はレポートを JSON で返します。csv、xlsx、pdf は同じ行を添付ファイルとして返します(ページ分割されたレポートは全ページ、最大 50000 行)。 |
| day_from | クエリ | オプション | 最初の UTC の日付(この日を含みます)。デフォルトは day_to の29日前です。day_to と組み合わせた期間は最大92日です。 |
| day_to | クエリ | オプション | 最終UTC日(含む)。デフォルトは今日(UTC)。 |
| screen_id | クエリ | オプション | |
| 制限 | クエリ | オプション | 一覧表示する欠番の最大数です。新しい順に返されます。 |
リクエストテンプレートとレスポンス
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/playback/completeness'レスポンス
| ステータス | 意味 | 本文とヘッダー |
|---|---|---|
| 200 | 対象期間の完全性と欠番です。 | PlaybackCompleteness (application/json); ヘッダー: Cache-Control |
| 400 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+json) |
| 401 | 安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。 | 問題 (application/problem+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) |