RoomScope

最終更新

エクスポート

記録したセッションの CSV / Excel エクスポート。

すべての操作は API キーで認証します (Authorization: Bearer <key>) 。エラーには共通のエンベロープを使用します。詳しくは次のページを参照してください： エラー. このページは API の OpenAPI ドキュメントから生成しています。

エクスポートを一覧表示

GET/v1/exports

ワークスペースのエクスポートを新しい順に返します。一覧表示とダウンロードは無料です。

スコープexportクレジット無料

リクエスト

curl "https://api.toktokdata.live/v1/exports" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

レスポンス

200 OK
{  "items": [    {      "id": "7d59b188-dc23-4ac5-908f-a3a7aaf89f36",      "dataset": "live_sessions",      "format": "csv",      "status": "ready",      "rowCount": 2,      "filename": "roomscope-live_sessions-2026-11-01.csv",      "downloadUrl": "/v1/exports/7d59b188-dc23-4ac5-908f-a3a7aaf89f36/download",      "error": null,      "createdAt": "2026-11-01T11:15:45.241Z",      "completedAt": "2026-11-01T11:15:45.240Z"    },    {      "id": "a57ddf61-5f71-4fce-82d2-8d50941e0941",      "dataset": "live_sessions",      "format": "csv",      "status": "ready",      "rowCount": 2,      "filename": "roomscope-live_sessions-2026-11-01.csv",      "downloadUrl": "/v1/exports/a57ddf61-5f71-4fce-82d2-8d50941e0941/download",      "error": null,      "createdAt": "2026-11-01T11:11:46.114Z",      "completedAt": "2026-11-01T11:11:46.113Z"    }  ],  "provenance": {    "observedAt": "2026-11-01T11:15:45.240Z",    "freshness": "near_realtime",    "source": "workspace_exports",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "exports-v1",    "window": null  }}

エラー

  • 400 パラメーターまたはボディが不正です。問題の内容は code で示されます。
  • 401 API キーがないか、不明なキーです。
  • 403 キーに必要なスコープがないか、プランにその機能が含まれていません。
  • 429 リクエストレートを超えました。Retry-After に従ってください。

エクスポートを作成

POST/v1/exports

データセットをその場で作成し（小さな範囲の場合）、ダウンロード可能な状態のジョブを返します。

スコープexportクレジットエクスポート

リクエストボディ

リクエストボディ · POST /v1/exports
NameTypeDescription
datasetRequired
"live_sessions"
formatRequired
"csv" | "xlsx"xlsx には Excel を含むプランが必要です。
rangeDaysOptional
integer
Default: 30

リクエスト

curl -X POST "https://api.toktokdata.live/v1/exports" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY" \  -H "Content-Type: application/json" \  -d '{"dataset":"live_sessions","format":"csv","rangeDays":30}'

レスポンス

201 Created
{  "id": "7d59b188-dc23-4ac5-908f-a3a7aaf89f36",  "dataset": "live_sessions",  "format": "csv",  "status": "ready",  "rowCount": 2,  "filename": "roomscope-live_sessions-2026-11-01.csv",  "downloadUrl": "/v1/exports/7d59b188-dc23-4ac5-908f-a3a7aaf89f36/download",  "error": null,  "createdAt": "2026-11-01T11:15:45.241Z",  "completedAt": "2026-11-01T11:15:45.240Z"}

エラー

  • 400 パラメーターまたはボディが不正です。問題の内容は code で示されます。
  • 401 API キーがないか、不明なキーです。
  • 402 ワークスペースのクレジットウォレットでこの呼び出しをまかなえません。クレジットがリセットされる日時は resetAt で示されます。
  • 403 キーに必要なスコープがないか、プランにその機能が含まれていません。
  • 429 リクエストレートを超えました。Retry-After に従ってください。

エクスポートを取得

GET/v1/exports/{job_id}

エクスポート 1 件のステータスとダウンロードリンク。

スコープexportクレジット無料

パスパラメーター

パスパラメーター · GET /v1/exports/{job_id}
NameTypeDescription
job_idRequired
stringエクスポートの ID。

リクエスト

curl "https://api.toktokdata.live/v1/exports/109da4de-c958-5e53-9b3d-abd2c89b621e" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

レスポンス

200 OK
{  "id": "109da4de-c958-5e53-9b3d-abd2c89b621e",  "dataset": "live_sessions",  "format": "csv",  "status": "ready",  "rowCount": 2,  "filename": "roomscope-live_sessions-2026-11-01.csv",  "downloadUrl": "/v1/exports/109da4de-c958-5e53-9b3d-abd2c89b621e/download",  "error": null,  "createdAt": "2026-11-01T09:51:44.935Z",  "completedAt": "2026-11-01T09:51:44.935Z",  "provenance": {    "observedAt": "2026-11-01T09:51:44.935Z",    "freshness": "near_realtime",    "source": "workspace_exports",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "exports-v1",    "window": null  }}

エラー

  • 400 パラメーターまたはボディが不正です。問題の内容は code で示されます。
  • 401 API キーがないか、不明なキーです。
  • 403 キーに必要なスコープがないか、プランにその機能が含まれていません。
  • 429 リクエストレートを超えました。Retry-After に従ってください。

エクスポートをダウンロード

GET/v1/exports/{job_id}/download

ファイル本体（text/csv または Excel）を添付として返します。準備ができるまでは 409 です。

スコープexportクレジット無料

パスパラメーター

パスパラメーター · GET /v1/exports/{job_id}/download
NameTypeDescription
job_idRequired
stringエクスポートの ID。

リクエスト

curl "https://api.toktokdata.live/v1/exports/109da4de-c958-5e53-9b3d-abd2c89b621e/download" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

レスポンス

200 を返し、ファイルを添付として送信します。

エラー

  • 400 パラメーターまたはボディが不正です。問題の内容は code で示されます。
  • 401 API キーがないか、不明なキーです。
  • 403 キーに必要なスコープがないか、プランにその機能が含まれていません。
  • 429 リクエストレートを超えました。Retry-After に従ってください。
このページは役に立ちましたか？