RoomScope

Son güncelleme

Dışa aktarmalar

Kaydedilen oturumların CSV ve Excel dışa aktarmaları.

Her işlemde kimlik doğrulama bir API anahtarıyla yapılır (Authorization: Bearer <key>) ve hatalar şu sayfada açıklanan ortak zarfı kullanır: Hatalar. API’nin OpenAPI belgesinden üretilmiştir.

Dışa aktarmaları listeleme

GET/v1/exports

Çalışma alanının dışa aktarmaları, en yeniden eskiye. Listeleme ve indirme ücretsizdir.

KapsamexportKredilerÜcretsiz

İstek

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

Yanıt

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

Hatalar

  • 400 Geçersiz parametre veya gövde; sorunu code belirtir.
  • 401 Eksik veya bilinmeyen API anahtarı.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı; Retry-After değerine uyun.

Dışa aktarma oluşturma

POST/v1/exports

Veri kümesini hemen oluşturur (küçük aralıklar) ve indirilmeye hazır işi döndürür.

KapsamexportKredilerDışa aktarma

İstek gövdesi

İstek gövdesi · POST /v1/exports
NameTypeDescription
datasetRequired
"live_sessions"
formatRequired
"csv" | "xlsx"xlsx, Excel’i içeren bir plan gerektirir.
rangeDaysOptional
integer
Default: 30

İstek

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

Yanıt

201 Oluşturuldu
{  "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"}

Hatalar

  • 400 Geçersiz parametre veya gövde; sorunu code belirtir.
  • 401 Eksik veya bilinmeyen API anahtarı.
  • 402 Çalışma alanının kredi cüzdanı çağrıyı karşılayamıyor; kredilerin ne zaman sıfırlanacağını resetAt belirtir.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı; Retry-After değerine uyun.

Dışa aktarmayı alma

GET/v1/exports/{job_id}

Tek bir dışa aktarmanın durumu ve indirme bağlantısı.

KapsamexportKredilerÜcretsiz

Yol parametreleri

Yol parametreleri · GET /v1/exports/{job_id}
NameTypeDescription
job_idRequired
stringDışa aktarma kimliği.

İstek

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

Yanıt

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

Hatalar

  • 400 Geçersiz parametre veya gövde; sorunu code belirtir.
  • 401 Eksik veya bilinmeyen API anahtarı.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı; Retry-After değerine uyun.

Dışa aktarmayı indirme

GET/v1/exports/{job_id}/download

Dosyanın kendisi (text/csv veya Excel), ek olarak. Hazır olana kadar 409.

KapsamexportKredilerÜcretsiz

Yol parametreleri

Yol parametreleri · GET /v1/exports/{job_id}/download
NameTypeDescription
job_idRequired
stringDışa aktarma kimliği.

İstek

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

Yanıt

200 dosyayı ek olarak döndürür.

Hatalar

  • 400 Geçersiz parametre veya gövde; sorunu code belirtir.
  • 401 Eksik veya bilinmeyen API anahtarı.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı; Retry-After değerine uyun.
Bu sayfa işinize yaradı mı?