RoomScope

Última atualização

Exportações

Exportações em CSV e Excel das sessões registradas.

Toda operação se autentica com uma chave de API (Authorization: Bearer <key>) e os erros usam o envelope comum descrito em Erros. Gerado a partir do documento OpenAPI da API.

Listar exportações

GET/v1/exports

Exportações do espaço de trabalho, das mais recentes às mais antigas. Listar e baixar é gratuito.

EscopoexportCréditosGrátis

Requisição

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

Resposta

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

Erros

  • 400 Parâmetro ou corpo inválido; code indica o problema.
  • 401 Chave de API ausente ou desconhecida.
  • 403 A chave não tem o escopo, ou o plano não inclui o recurso.
  • 429 Taxa de requisições excedida; respeite o Retry-After.

Criar uma exportação

POST/v1/exports

Gera o conjunto de dados na hora (intervalos pequenos) e retorna o job, pronto para download.

EscopoexportCréditosExportação

Corpo da requisição

Corpo da requisição · POST /v1/exports
NameTypeDescription
datasetRequired
"live_sessions"
formatRequired
"csv" | "xlsx"xlsx exige um plano que inclua Excel.
rangeDaysOptional
integer
Default: 30

Requisição

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

Resposta

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

Erros

  • 400 Parâmetro ou corpo inválido; code indica o problema.
  • 401 Chave de API ausente ou desconhecida.
  • 402 A carteira de créditos do espaço de trabalho não cobre a chamada; resetAt indica quando os créditos são renovados.
  • 403 A chave não tem o escopo, ou o plano não inclui o recurso.
  • 429 Taxa de requisições excedida; respeite o Retry-After.

Obter uma exportação

GET/v1/exports/{job_id}

Status e link de download de uma exportação.

EscopoexportCréditosGrátis

Parâmetros de caminho

Parâmetros de caminho · GET /v1/exports/{job_id}
NameTypeDescription
job_idRequired
stringID da exportação.

Requisição

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

Resposta

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

Erros

  • 400 Parâmetro ou corpo inválido; code indica o problema.
  • 401 Chave de API ausente ou desconhecida.
  • 403 A chave não tem o escopo, ou o plano não inclui o recurso.
  • 429 Taxa de requisições excedida; respeite o Retry-After.

Baixar uma exportação

GET/v1/exports/{job_id}/download

O próprio arquivo (text/csv ou Excel), como anexo. 409 até que esteja pronto.

EscopoexportCréditosGrátis

Parâmetros de caminho

Parâmetros de caminho · GET /v1/exports/{job_id}/download
NameTypeDescription
job_idRequired
stringID da exportação.

Requisição

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

Resposta

200 com o arquivo como anexo.

Erros

  • 400 Parâmetro ou corpo inválido; code indica o problema.
  • 401 Chave de API ausente ou desconhecida.
  • 403 A chave não tem o escopo, ou o plano não inclui o recurso.
  • 429 Taxa de requisições excedida; respeite o Retry-After.
Esta página foi útil?