อัปเดตล่าสุด
การส่งออก
ส่งออกเซสชันที่บันทึกไว้เป็น CSV และ Excel
ทุกการดำเนินการยืนยันตัวตนด้วย API key (Authorization: Bearer <key>) และข้อผิดพลาดใช้โครงสร้างร่วมที่อธิบายไว้ใน ข้อผิดพลาด. สร้างจากเอกสาร OpenAPI ของ API
แสดงรายการไฟล์ส่งออก
/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พารามิเตอร์หรือ body ไม่ถูกต้องcodeจะระบุปัญหา401ไม่มี API key หรือไม่รู้จัก API key403คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้429เกินอัตราคำขอ (ต่อวินาที ต่อนาที หรือต่อวัน) โปรดทำตามRetry-After
สร้างไฟล์ส่งออก
/v1/exportsสร้างชุดข้อมูล: live_sessions (เซสชันที่ติดตามในช่วงเวลา), rankings (อันดับทางการหนึ่งรายการตามที่แพ็กเกจของคุณเห็น แถวที่ถูกปิดบังยังคงถูกปิดบัง ต้องมี 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
Body ของคำขอ
| 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พารามิเตอร์หรือ body ไม่ถูกต้องcodeจะระบุปัญหา401ไม่มี API key หรือไม่รู้จัก API key402กระเป๋าเครดิตของเวิร์กสเปซมีไม่พอสำหรับการเรียกนี้resetAtบอกเวลาที่เครดิตจะรีเซ็ต403คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้429เกินอัตราคำขอ (ต่อวินาที ต่อนาที หรือต่อวัน) โปรดทำตามRetry-After
ดึงไฟล์ส่งออก
/v1/exports/{job_id}สถานะและลิงก์ดาวน์โหลดของไฟล์ส่งออกหนึ่งรายการ
พารามิเตอร์ใน path
| 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พารามิเตอร์หรือ body ไม่ถูกต้องcodeจะระบุปัญหา401ไม่มี API key หรือไม่รู้จัก API key403คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้429เกินอัตราคำขอ (ต่อวินาที ต่อนาที หรือต่อวัน) โปรดทำตามRetry-After
ดาวน์โหลดไฟล์ส่งออก
/v1/exports/{job_id}/downloadตัวไฟล์ (text/csv หรือ Excel) ในรูปแบบไฟล์แนบ ได้รับ 409 จนกว่าไฟล์จะพร้อม
พารามิเตอร์ใน path
| 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พารามิเตอร์หรือ body ไม่ถูกต้องcodeจะระบุปัญหา401ไม่มี API key หรือไม่รู้จัก API key403คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้429เกินอัตราคำขอ (ต่อวินาที ต่อนาที หรือต่อวัน) โปรดทำตามRetry-After