screenRIG
サインイン開始する

API リファレンス

レポート API

レポート: フォルダー別・タグ別の集計、CSV・XLSX・PDF ファイル、メールの定期送信

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

OpenAPI YAMLOpenAPI JSON問題 YAMLAPI の概要

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

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

レポート: フォルダー別・タグ別の集計、CSV・XLSX・PDF ファイル、メールの定期送信

GET/api/reports

レポートの種類を一覧

GET /api/reports/{kind} が作成するレポートの種類と、それぞれのフィルター、レポートの出力形式を一覧します。レポートのケイパビリティが必要です。

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

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/reports'

レスポンス

ステータス意味本文とヘッダー
200レポートの種類。ReportCatalog（application/json）
デフォルト

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

問題 (application/problem+json)
GET/api/reports/{kind}

レポートを取得

プロジェクトの集計値（稼働率のロールアップ、アラート行、画面の状態、直接キャンペーンの配信）からレポートを作成します。生のイベントは使いません。fleet_health、uptime、publishing、alerts は、from から to までの両端を含む UTC の日付（既定は直近30日）について、group_by の folder（既定）、screen、tag ごとに集計します。フォルダーには、その中とサブフォルダー内のすべての画面が含まれ、最初の行はプロジェクト全体です。folder_id はレポートをフォルダーとその内容に限定し、direct を付けるとフォルダーとその子フォルダー（画面単位ではフォルダー直下の画面）に限定します。alert_log は期間中に発生した各アラートを一覧します。proof_of_play はプロジェクトの直接キャンペーンの再生数を、キャンペーン、メディア、画面ごとに集計し、1 つの campaign_id または広告主のすべてのキャンペーンを対象にします。format json（既定）は表を返し、csv、xlsx、pdf は同じ表を添付ファイルとして返します。JSON 形式の fleet_health はすべてのプランで利用できます。それ以外の種類と、あらゆるファイル形式には、レポートのプラン機能が必要です（402 feature_not_in_plan）。

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

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
種類パス必須レポートの種類（GET /api/reports）。
フォーマットクエリオプションjson（既定）はレポートを JSON で返します。csv、xlsx、pdf は同じ行を添付ファイルとして返します（ページ分割されたレポートは全ページ、最大 50000 行）。
開始クエリオプション最初の UTC の日（含む）。既定は to の29日前。to との間隔は最大 366 日。
からクエリオプション最終UTC日（含む）。デフォルトは今日（UTC）。
group_byクエリオプション行の単位。alert_log と proof_of_play では使いません。
folder_idクエリオプションこの画面フォルダーとその中のすべてだけ。
directクエリオプションfolder_id と併用: フォルダー直下の画面だけ（group_by screen）、またはフォルダーとその子フォルダー（group_by folder）。
タグクエリオプションこのタグを持つ画面だけ。
campaign_idクエリオプションproof_of_play: 1 つの直接キャンペーン。
advertiserクエリオプションproof_of_play: この広告主またはスポンサーのキャンペーン（正確な名前、大文字小文字は区別しません）。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/reports/KIND'

レスポンス

ステータス意味本文とヘッダー
200表としてのレポート。csv、xlsx、pdf の場合はファイル。レポート（application/json）、文字列（text/csv）、文字列（application/vnd.openxmlformats-officedocument.spreadsheetml.sheet）、文字列（application/pdf）、ヘッダー: Cache-Control
400

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

問題 (application/problem+json)
402

feature_not_in_plan — レポートは Plus に含まれます。JSON 形式の fleet_health 以外のすべての種類と、あらゆる種類の csv、xlsx、pdf に必要です。JSON 形式の fleet_health（既定の形式）はすべてのプランで利用でき、レポートの種類と既存のレポートルートのエクスポートも同様です。問題には、機能、プロジェクトのプラン、required_plan が示されます。

問題 (application/problem+json)
403

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

問題 (application/problem+json)
404

安定した 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)
GET/api/report-subscriptions

レポート購読を一覧

プロジェクトのスケジュール済みレポートを古い順に一覧します（最大 50 件）。各レポートの次回の実行と前回の結果を含みます。プロジェクトのケイパビリティが必要です。

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

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/report-subscriptions'

レスポンス

ステータス意味本文とヘッダー
200プロジェクトのレポート購読。ReportSubscriptionList（application/json）
デフォルト

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

問題 (application/problem+json)
POST/api/report-subscriptions

レポート購読を作成

レポートを PDF、XLSX、CSV の添付ファイルとして、毎日・毎週・毎月、指定したタイムゾーンの時刻にメールで送るよう設定します。

各実行は直前の期間を UTC の日単位で対象にします（前日、直前の7日間、または先月）。recipients はプロジェクトのメンバーで、user_id またはメンバーのメールアドレスで指定します。メンバー以外は拒否されるため、購読が外部の人にメールを送る手段になることはなく、退出したメンバーには届かなくなります。

失敗した実行は再試行され、last_status failed と last_error で示されます。1 組織あたり、すべてのプロジェクトを合わせて最大 50 件（report_subscription_limit_reached）。

認証
projectBearer または dashboardSession
リクエスト本文
ReportSubscriptionWrite
操作ID
createReportSubscription

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。

リクエスト本文フィールド

フィールド説明
name（必須、文字列）minLength: 1 maxLength: 100
種類（必須、文字列）使用可能な値: "fleet_health", "uptime", "publishing", "alerts", "alert_log", "proof_of_play"
filters（任意、オブジェクト）日付以外のレポートのフィルター（GET /api/reports で一覧できます）。
schedule（必須、ReportSchedule）
format（必須、文字列）使用可能な値: "pdf", "xlsx", "csv"
recipients（必須、配列）プロジェクトメンバーの user_id またはメールアドレス。
enabled（任意、ブール値）true
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/report-subscriptions'

レスポンス

ステータス意味本文とヘッダー
201作成されました。ReportSubscription (application/json)、ヘッダー: ETag
400

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

問題 (application/problem+json)
402feature_not_in_plan — レポートは Plus に含まれます。問題には、機能、プロジェクトのプラン、required_plan が示されます。問題 (application/problem+json)
409report_subscription_limit_reached.問題 (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/api/report-subscriptions/{id}

レポート購読を取得

プロジェクトのケイパビリティが必要です。

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

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/report-subscriptions/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200レポート購読 1 件。ReportSubscription (application/json)、ヘッダー: ETag
404

安定した 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)
PATCH/api/report-subscriptions/{id}

レポート購読を更新

name、filters、schedule、format、recipients、enabled のいずれかを変更します。レポートの種類は変更できません。スケジュールを変更した場合や購読を再度有効にした場合は、次の実行から再開します。If-Match には読み取ったリビジョンを指定します（古い場合は revision_conflict）。

認証
projectBearer または dashboardSession
リクエスト本文
ReportSubscriptionPatch
操作ID
updateReportSubscription

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。
If-Matchヘッダーオプション購読のリビジョン（引用符付きでも付きなしでも可）。

リクエスト本文フィールド

フィールド説明
name（任意、文字列）minLength: 1 maxLength: 100
filters（任意、オブジェクト）
schedule（任意、ReportSchedule）
format（任意、文字列）使用可能な値: "pdf", "xlsx", "csv"
recipients（任意、配列）
enabled（任意、ブール値）
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PATCH --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/report-subscriptions/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200更新しました。ReportSubscription (application/json)、ヘッダー: ETag
400

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

問題 (application/problem+json)
402feature_not_in_plan — レポートは Plus に含まれます。購読をオフにするだけの変更は引き続き利用できます。問題には、機能、プロジェクトのプラン、required_plan が示されます。問題 (application/problem+json)
404

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

問題 (application/problem+json)
409

安定した 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)
削除/api/report-subscriptions/{id}

レポート購読を削除

購読を削除します。以降は何も送信されません。

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

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/report-subscriptions/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
204削除されました。本文なし
404

安定した 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)
POST/api/report-subscriptions/{id}/send

レポート購読を送信

今すぐ購読の宛先にレポートを送ります。対象は、今スケジュールどおりに実行した場合の期間で、スケジュールは動きません。応答は、この送信の結果（last_status は delivered または failed、last_error）を含む購読です。

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

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/report-subscriptions/RESOURCE_ID/send'

レスポンス

ステータス意味本文とヘッダー
200この送信の結果を含む購読。ReportSubscription（application/json）
404

安定した 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)