นักพัฒนา

เอกสารประกอบ API ของนักพัฒนา ส่วนหัว และการค้นพบ

API ภายนอก, เวิร์กโฟลว์คีย์ API, การขนส่ง MCP และไฟล์การค้นพบที่เครื่องอ่านได้ได้รับการบันทึกไว้ที่นี่พร้อมกับเส้นทางสดที่ผลิตภัณฑ์ใช้

คีย์ API

สร้างและเพิกถอนคีย์ในแดชบอร์ด > การตั้งค่า > คีย์ API หรือใช้เส้นทางการจัดการที่ลงชื่อเข้าใช้

มืออาชีพและองค์กรเท่านั้น

ส่วนที่เหลือ API

Call https://tubeanalytics.net/api/external/v1 with Bearer auth.

การตอบสนอง JSON พร้อมข้อผิดพลาดที่มีโครงสร้าง

การขนส่งเอ็มซีพี

Connect agents to https://tubeanalytics.net/api/mcp or use npm run mcp:stdio.

รองรับ HTTP และ stdio แบบสตรีมได้

ไฟล์การค้นพบ

Use /openapi.json, /mcp.json, /ai-pricing.json, and /ai.txt as the machine-readable source of truth.

ทันสมัยอยู่เสมอด้วยเส้นทางสด

เริ่มต้นอย่างรวดเร็ว

ลองใช้จุดสิ้นสุดที่ใช้งานอยู่ แทนที่ channel_id และ YOUR_API_KEY ด้วยค่าจริง:

curl -X GET "https://tubeanalytics.net/api/external/v1/analytics?channel_id=<channel_id>&range=28d" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Accept: application/json"

JavaScript

const res = await fetch("https://tubeanalytics.net/api/external/v1/analytics?channel_id=<id>&range=28d", {
  headers: { Authorization: "Bearer <api_key>" }
});
const data = await res.json();

Python

import httpx
res = httpx.get(
    f"{apiBase}/analytics",
    params={"channel_id": "<id>", "range": "28d"},
    headers={"Authorization": "Bearer <api_key>"}
)
data = res.json()
channel_id accepts either the TubeAnalytics channel ID or the YouTube channel ID. The same Bearer key works for every external endpoint below. API access requires a Professional or Enterprise plan.

วิธีการเชื่อมต่อ

1

เชื่อมต่อช่อง YouTube ในแดชบอร์ด

ข้อมูล API ภายนอกมาจากช่องทางที่เชื่อมต่อ ลงชื่อเข้าใช้ เชื่อมต่อช่อง และรอให้การซิงค์ครั้งแรกเสร็จสิ้นก่อนที่จะทำการเรียกแบบเซิร์ฟเวอร์ถึงเซิร์ฟเวอร์

2

สร้างคีย์ API

เปิดแดชบอร์ด > การตั้งค่า > คีย์ API บนบัญชี Professional หรือ Enterprise หรือเรียก POST /api/v1/keys จากเซสชันที่ได้รับการตรวจสอบสิทธิ์

3

ส่งคำขอที่ได้รับการรับรองความถูกต้องของผู้ถือ

ใช้การอนุญาต: ผู้ถือ <api_key> กับทุกคำขอภายนอก เก็บคีย์ไว้ฝั่งเซิร์ฟเวอร์และอย่าฝังไว้ในโค้ดไคลเอ็นต์

4

ใช้ไฟล์การค้นพบสำหรับเครื่องมือและเอเจนต์

ดึงข้อกำหนด OpenAPI, รายการ MCP, รายการราคา ai และไฟล์ ai.txt เมื่อสร้างไคลเอ็นต์ เชื่อมต่อตัวแทน หรือตรวจสอบความถูกต้องของการผสานรวม

ปลายทางอ้างอิง

https://tubeanalytics.net/api/external/v1undefined
แสดงรายการช่องที่เชื่อมต่อพร้อมชื่อ, YouTube ID และสถานะการเชื่อมต่อ
https://tubeanalytics.net/api/external/v1undefined
ดึงข้อมูลช่องที่เชื่อมต่อหนึ่งช่องด้วยรหัสภายในหรือรหัสช่อง YouTube
https://tubeanalytics.net/api/external/v1undefined
การวิเคราะห์แบบรวม: ยอดดู สมาชิก เวลาในการรับชม CTR แหล่งที่มาของการเข้าชม — กรองตามช่วง
https://tubeanalytics.net/api/external/v1undefined
วิดีโอแบบแบ่งหน้าที่มีการดูต่อวิดีโอ, CTR, วันที่เผยแพร่ — รองรับการเรียงลำดับ, จำกัด, ออฟเซ็ต
https://tubeanalytics.net/api/external/v1undefined
ข้อมูลประชากรของผู้ชม (อายุ เพศ ภูมิศาสตร์) สุขภาพของสมาชิก และการแบ่งกลุ่ม
https://tubeanalytics.net/api/external/v1undefined
ติดตามคู่แข่งด้วยจำนวนสมาชิก ยอดดูเฉลี่ย และช่วง RPM โดยประมาณ
ไฟล์การค้นพบที่ /openapi.json, /mcp.json และ /ai.txt เป็นแหล่งที่มาของความจริงที่เครื่องสามารถอ่านได้

พารามิเตอร์แบบสอบถาม

ตำแหน่งข้อมูล API ภายนอกส่วนใหญ่ยอมรับพารามิเตอร์การสืบค้นทั่วไปสำหรับการกรอง การแบ่งหน้า และการเรียงลำดับ สคีมาแบบเต็มต่อปลายทางอยู่ในข้อมูลจำเพาะของ OpenAPI

channel_id
string
จำเป็นสำหรับการวิเคราะห์ วิดีโอ และผู้ชม ยอมรับ TubeAnalytics ID ภายในหรือ ID ช่อง YouTube
range
string
กรอบเวลา: 7d, 28d (ค่าเริ่มต้น), 90d, 365d
limit
integer
ผลลัพธ์ต่อหน้า ค่าเริ่มต้น 20 สูงสุด 100
offset
integer
บันทึกที่จะข้าม ใช้กับขีดจำกัดเพื่อแบ่งหน้าผ่านชุดผลลัพธ์
sort
string
ฟิลด์เรียงลำดับ (เช่น PublishedAt, มุมมอง, CTR) คำนำหน้าด้วย - สำหรับจากมากไปน้อย

การรับรองความถูกต้องและส่วนหัว

คำขอภายนอกใช้รูปแบบคีย์ Bearer API ในส่วนหัวการอนุญาต เก็บคีย์ฝั่งเซิร์ฟเวอร์ไว้ สร้างและหมุนเวียนคีย์จากแดชบอร์ด > การตั้งค่า > คีย์ API หรือเส้นทางการจัดการที่ลงชื่อเข้าใช้

Authorization
Bearer <api_key>
Accept
application/json
Content-Type
application/json
Rate-limit headers
X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
Retry header
Retry-After on 429 responses

เส้นทางการจัดการที่ลงชื่อเข้าใช้

เส้นทางเหล่านี้มีไว้สำหรับเซสชันแดชบอร์ดที่ได้รับการตรวจสอบสิทธิ์ ไม่ใช่ไคลเอ็นต์ API แบบเซิร์ฟเวอร์ถึงเซิร์ฟเวอร์:

  • GET /api/v1/keys แสดงรายการคีย์ API
  • POST /api/v1/keys สร้างคีย์ API ใหม่
  • DELETE /api/v1/keys/:keyId เพิกถอนกุญแจ
  • GET /api/v1/users/profile and related dashboard session routes ยังคงแยกจากกัน
คีย์ API มีเฉพาะในแผน Professional และ Enterprise เท่านั้น ผู้ใช้ระดับเริ่มต้นจะเห็นข้อความแจ้งการอัปเกรดในการตั้งค่า

การเข้าถึงและข้อจำกัด

พื้นผิวการกำหนดราคาประกาศสิทธิ์การเรียก API รายเดือนตามแผน ในขณะที่ API ภายนอกที่ใช้งานจริงบังคับใช้ขีดจำกัดคำขอในหน้าต่างเลื่อนและส่งกลับส่วนหัวขีดจำกัดอัตราในทุกการตอบกลับ โปรดคำนึงถึงทั้งสองอย่างเมื่อสร้างการลองใหม่ของลูกค้าและแดชบอร์ดโควต้า

Starter
1 channel max channels
Unavailable
Upgrade required
No external API access
Professional
3 channels max channels
Enabled
5,000 calls / month
1,000 requests/hour
Enterprise
5 channels max channels
Enabled
20,000 calls / month
10,000 requests/hour

ในการใช้งานปัจจุบัน API ภายนอกจะส่งคืน X-RateLimit-Limit, X-RateLimit-Remaining และ X-RateLimit-Reset เมื่อตอบสนองสำเร็จ บวกกับ Retry-After เมื่อคำขอถูกจำกัด

รูปแบบข้อผิดพลาด

เส้นทาง API ภายนอกส่งคืนข้อผิดพลาด JSON ที่มีโครงสร้างพร้อม error.code และ error.message ใช้โค้ดเพื่อแยกการจัดการข้อผิดพลาดและข้อความสำหรับบันทึกที่มนุษย์สามารถอ่านได้

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "channel_id query parameter is required"
  }
}

สถานะทั่วไป

  • 400 พารามิเตอร์คำขอหายไปหรือไม่ถูกต้อง
  • 401 คีย์ API หายไปหรือไม่ถูกต้อง
  • 403 คีย์ API ถูกต้องแต่แผนไม่มีสิทธิ์
  • 404 ไม่พบช่องทางหรือทรัพยากรที่เชื่อมต่อ
  • 429 เกินขีดจำกัดอัตรา
  • 500 ข้อผิดพลาดเซิร์ฟเวอร์ที่ไม่คาดคิด

พร้อมที่จะสร้างหรือยัง?

ลงทะเบียนแผน Professional หรือ Enterprise เพื่อรับการเข้าถึง API มีบัญชีอยู่แล้ว? ข้ามไปที่แดชบอร์ดเพื่อสร้างคีย์ API