RoomScope

อัปเดตล่าสุด

การส่งออก

ส่งออกเซสชันที่บันทึกไว้เป็น CSV และ Excel

ทุกการดำเนินการยืนยันตัวตนด้วย API key (Authorization: Bearer <key>) และข้อผิดพลาดใช้โครงสร้างร่วมที่อธิบายไว้ใน ข้อผิดพลาด. สร้างจากเอกสาร OpenAPI ของ API

แสดงรายการไฟล์ส่งออก

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 พารามิเตอร์หรือ body ไม่ถูกต้อง code จะระบุปัญหา
  • 401 ไม่มี API key หรือไม่รู้จัก API key
  • 403 คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้
  • 429 เกินอัตราคำขอ ให้ปฏิบัติตาม Retry-After

สร้างไฟล์ส่งออก

POST/v1/exports

สร้างชุดข้อมูลทันที (สำหรับช่วงข้อมูลขนาดเล็ก) และส่งคืนงานที่พร้อมดาวน์โหลด

สโคปexportเครดิตส่งออก

Body ของคำขอ

Body ของคำขอ · 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 สร้างแล้ว
{  "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 พารามิเตอร์หรือ body ไม่ถูกต้อง code จะระบุปัญหา
  • 401 ไม่มี API key หรือไม่รู้จัก API key
  • 402 กระเป๋าเครดิตของเวิร์กสเปซมีไม่พอสำหรับการเรียกนี้ resetAt บอกเวลาที่เครดิตจะรีเซ็ต
  • 403 คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้
  • 429 เกินอัตราคำขอ ให้ปฏิบัติตาม Retry-After

ดึงไฟล์ส่งออก

GET/v1/exports/{job_id}

สถานะและลิงก์ดาวน์โหลดของไฟล์ส่งออกหนึ่งรายการ

สโคปexportเครดิตฟรี

พารามิเตอร์ใน path

พารามิเตอร์ใน path · GET /v1/exports/{job_id}
NameTypeDescription
job_idRequired
stringid ของไฟล์ส่งออก

คำขอ

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 พารามิเตอร์หรือ body ไม่ถูกต้อง code จะระบุปัญหา
  • 401 ไม่มี API key หรือไม่รู้จัก API key
  • 403 คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้
  • 429 เกินอัตราคำขอ ให้ปฏิบัติตาม Retry-After

ดาวน์โหลดไฟล์ส่งออก

GET/v1/exports/{job_id}/download

ตัวไฟล์ (text/csv หรือ Excel) ในรูปแบบไฟล์แนบ ได้รับ 409 จนกว่าไฟล์จะพร้อม

สโคปexportเครดิตฟรี

พารามิเตอร์ใน path

พารามิเตอร์ใน path · GET /v1/exports/{job_id}/download
NameTypeDescription
job_idRequired
stringid ของไฟล์ส่งออก

คำขอ

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

ผลลัพธ์

200 พร้อมไฟล์เป็นไฟล์แนบ

ข้อผิดพลาด

  • 400 พารามิเตอร์หรือ body ไม่ถูกต้อง code จะระบุปัญหา
  • 401 ไม่มี API key หรือไม่รู้จัก API key
  • 403 คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้
  • 429 เกินอัตราคำขอ ให้ปฏิบัติตาม Retry-After
หน้านี้มีประโยชน์หรือไม่