RoomScope

Terakhir diperbarui

Ekspor

Ekspor CSV dan Excel dari sesi yang terekam.

Setiap operasi diautentikasi dengan API key (Authorization: Bearer <key>) dan error memakai amplop bersama yang dijelaskan di Error. Dibuat dari dokumen OpenAPI milik API.

Daftar ekspor

GET/v1/exports

Ekspor milik workspace, dari yang terbaru. Menampilkan daftar dan mengunduh tidak dikenai biaya.

ScopeexportKreditGratis

Permintaan

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

Respons

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  }}

Error

  • 400 Parameter atau body tidak valid; code menyebutkan masalahnya.
  • 401 API key tidak ada atau tidak dikenal.
  • 403 Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.
  • 429 Laju permintaan terlampaui; patuhi Retry-After.

Buat ekspor

POST/v1/exports

Membuat dataset seketika (untuk rentang kecil) dan mengembalikan job yang siap diunduh.

ScopeexportKreditEkspor

Body permintaan

Body permintaan · POST /v1/exports
NameTypeDescription
datasetRequired
"live_sessions"
formatRequired
"csv" | "xlsx"xlsx memerlukan paket yang mencakup Excel.
rangeDaysOptional
integer
Default: 30

Permintaan

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}'

Respons

201 Dibuat
{  "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"}

Error

  • 400 Parameter atau body tidak valid; code menyebutkan masalahnya.
  • 401 API key tidak ada atau tidak dikenal.
  • 402 Dompet kredit workspace tidak dapat menutup biaya panggilan ini; resetAt menunjukkan kapan kredit di-reset.
  • 403 Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.
  • 429 Laju permintaan terlampaui; patuhi Retry-After.

Ambil ekspor

GET/v1/exports/{job_id}

Status dan tautan unduhan satu ekspor.

ScopeexportKreditGratis

Parameter path

Parameter path · GET /v1/exports/{job_id}
NameTypeDescription
job_idRequired
stringId ekspor.

Permintaan

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

Respons

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  }}

Error

  • 400 Parameter atau body tidak valid; code menyebutkan masalahnya.
  • 401 API key tidak ada atau tidak dikenal.
  • 403 Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.
  • 429 Laju permintaan terlampaui; patuhi Retry-After.

Unduh ekspor

GET/v1/exports/{job_id}/download

File itu sendiri (text/csv atau Excel), sebagai lampiran. 409 hingga file siap.

ScopeexportKreditGratis

Parameter path

Parameter path · GET /v1/exports/{job_id}/download
NameTypeDescription
job_idRequired
stringId ekspor.

Permintaan

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

Respons

200 dengan file sebagai lampiran.

Error

  • 400 Parameter atau body tidak valid; code menyebutkan masalahnya.
  • 401 API key tidak ada atau tidak dikenal.
  • 403 Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.
  • 429 Laju permintaan terlampaui; patuhi Retry-After.
Apakah halaman ini membantu?