开发商
开发者 API 文档、标头和发现
外部 API、API 密钥工作流程、MCP 传输和机器可读的发现文件均与产品使用的实时路径一起记录在此处。
API 密钥
在仪表板 > 设置 > API 密钥中创建和撤销密钥，或使用登录的管理路由。
仅限专业版和企业版。
休息API
Call https://www.tubeanalytics.net/api/external/v1 with Bearer auth.
带有结构化错误的 JSON 响应。
MCP运输
Connect agents to https://www.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://www.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://www.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.如何连接
在仪表板中连接 YouTube 频道
外部API数据来自连接的通道。登录、连接通道并等待初始同步完成，然后再进行服务器到服务器调用。
创建 API 密钥
在 Professional 或 Enterprise 帐户上打开仪表板 > 设置 > API 密钥，或从经过身份验证的会话调用 POST /api/v1/keys。
发送经过承载验证的请求
对每个外部请求使用授权：Bearer <api_key>。将密钥保留在服务器端，并且不要将它们嵌入客户端代码中。
使用工具和代理的发现文件
生成客户端、连接代理或验证集成时，提取 OpenAPI 规范、MCP 清单、ai 定价清单和 ai.txt 文件。
参考终点
查询参数
大多数外部 API 端点接受用于过滤、分页和排序的通用查询参数。每个端点的完整架构位于 OpenAPI 规范中。
channel_idrangelimitoffsetsort身份验证和标头
外部请求在授权标头中使用 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 调用限额，而实时外部 API 强制执行滑动窗口请求限制并在每次响应时返回速率限制标头。在构建客户端重试和配额仪表板时请记住这两点。
在当前实现中，外部 API 在成功响应时返回 X-RateLimit-Limit、X-RateLimit-Remaining 和 X-RateLimit-Reset，在请求受到限制时返回 Retry-After。
错误格式
外部 API 路由返回带有 error.code 和 error.message 的结构化 JSON 错误。使用代码对错误处理和人类可读日志的消息进行分支。
{
"error": {
"code": "BAD_REQUEST",
"message": "channel_id query parameter is required"
}
}常见状态
- 400 请求参数缺失或无效
- 401 API 密钥缺失或无效
- 403 API 密钥有效，但该计划不符合条件
- 404 未找到连接的频道或资源
- 429 超出速率限制
- 500 服务器意外错误
准备好建造了吗？
注册专业版或企业版计划以获得 API 访问权限。已经有帐户？跳转到仪表板以创建 API 密钥。