最終更新
エクスポート
記録したセッションの CSV / Excel エクスポート。
すべての操作は API キーで認証します (Authorization: Bearer <key>) 。エラーには共通のエンベロープを使用します。詳しくは次のページを参照してください: エラー. このページは API の OpenAPI ドキュメントから生成しています。
エクスポートを一覧表示
/v1/exportsワークスペースのエクスポートを新しい順に返します。一覧表示とダウンロードは無料です。
リクエスト
curl "https://api.next.toktokdata.live/v1/exports" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"レスポンス
{ "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で示されます。401API キーがないか、不明なキーです。403キーに必要なスコープがないか、プランにその機能が含まれていません。429リクエストのレートを超えました(毎秒・毎分・毎日のいずれか)。Retry-Afterに従ってください。
エクスポートを作成
/v1/exportsデータセットを作成します: live_sessions(期間内のフォロー中セッション)、rankings(プランに応じた公式ランキング 1 件。マスクされた行はマスクのまま。rank:read が必要)、gifters(記録したルームのギフター。rangeDays が 7 以下なら 7 日間、それ以外は 30 日間。region は任意。gifter:read と Pro プランが必要)、watchlist または recruit_pipeline(スカウトのマーク。Pro プラン以上。どちらもサインイン中のセッションのみ)。1,000 行までならジョブは ready(201)で返り、それを超えると pending(202)になりバックグラウンドで作成されます。ready になるまで確認してください。各ファイルには出典が付きます: CSV の各行の末尾に source、observed_at、coverage_status、methodology、ワークブックには Provenance シートが追加されます。API キーで作成したときのみ課金されます。
リクエストボディ
| Name | Type | Description |
|---|---|---|
datasetRequired | "live_sessions" | "rankings" | "watchlist" | "recruit_pipeline" | "gifters" | |
boardOptional | string | rankings のボードキー(/v1/rankings/official と同じ)。 |
regionOptional | string | rankings の地域(gifters ではギフトを受け取ったクリエイターの地域)。Default: VN |
leagueTierOptional | string | rankings のリーグティア絞り込み(A1〜D5)。 |
formatRequired | "csv" | "xlsx" | xlsx には Excel を含むプランが必要です。 |
rangeDaysOptional | integer | Default: 30 |
リクエスト
curl -X POST "https://api.next.toktokdata.live/v1/exports" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY" \ -H "Content-Type: application/json" \ -d '{"dataset":"live_sessions","format":"csv","rangeDays":30}'レスポンス
{ "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で示されます。401API キーがないか、不明なキーです。402ワークスペースのクレジットウォレットでこの呼び出しをまかなえません。クレジットがリセットされる日時はresetAtで示されます。403キーに必要なスコープがないか、プランにその機能が含まれていません。429リクエストのレートを超えました(毎秒・毎分・毎日のいずれか)。Retry-Afterに従ってください。
エクスポートを取得
/v1/exports/{job_id}エクスポート 1 件のステータスとダウンロードリンク。
パスパラメーター
| Name | Type | Description |
|---|---|---|
job_idRequired | string | エクスポートの ID。 |
リクエスト
curl "https://api.next.toktokdata.live/v1/exports/109da4de-c958-5e53-9b3d-abd2c89b621e" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"レスポンス
{ "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で示されます。401API キーがないか、不明なキーです。403キーに必要なスコープがないか、プランにその機能が含まれていません。429リクエストのレートを超えました(毎秒・毎分・毎日のいずれか)。Retry-Afterに従ってください。
エクスポートをダウンロード
/v1/exports/{job_id}/downloadファイル本体(text/csv または Excel)を添付として返します。準備ができるまでは 409 です。
パスパラメーター
| Name | Type | Description |
|---|---|---|
job_idRequired | string | エクスポートの ID。 |
リクエスト
curl "https://api.next.toktokdata.live/v1/exports/109da4de-c958-5e53-9b3d-abd2c89b621e/download" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"レスポンス
200 を返し、ファイルを添付として送信します。
エラー
400パラメーターまたはボディが不正です。問題の内容はcodeで示されます。401API キーがないか、不明なキーです。403キーに必要なスコープがないか、プランにその機能が含まれていません。429リクエストのレートを超えました(毎秒・毎分・毎日のいずれか)。Retry-Afterに従ってください。