基础 URL
认证
每个请求都需要在X-API-Key 请求头中提供 API 密钥。详情请参阅 认证。
响应封装
大多数客户 API 端点使用以下响应封装: 成功:某些设置和写入操作(包括
/account/*、搜索词写入和生成、记录的 URL)使用 {"code": 200, "message": "200 OK", "data": {...}}。报告端点返回 HTML。解析响应前请查看各端点的响应示例。HTTP 状态码
日期范围筛选
大多数分析端点接受以下查询参数:
如果同时提供
duration_days 和 date_from/date_to,则显式日期范围优先。最大范围为 90 天。
AI 服务商筛选
分析端点接受providers 查询参数:
chatgpt、perplexity、google_ai_overview、gemini、claude。省略时会返回所有 AI 服务商的数据。
分页
返回大量结果的端点支持基于页码的分页:速率限制请求头
每个响应都会包含以下请求头:智能体化设置
智能体化设置
用户明确授权身份、团队和项目详情后,设置账户与项目。
端点
项目
列出并获取已跟踪的项目。
品牌别名
管理用于品牌识别的备用名称。
记录的 URL
管理用于搜索词发现的 URL 输入。
搜索词
搜索词、分析数据、AI 回复、域名和 URL。
竞争对手
带有聚合指标的竞争对手品牌。
来源
AI 回复中引用的来源域名。
主题
用于组织搜索词的主题分组。
概览
按搜索词聚合的分析数据。
可见度趋势
随时间变化的竞争对手指标时间序列。
来源分析
类别分布、表现趋势及机会点。
报告
生成独立的 HTML 可见度报告。
操作
审核建议、执行工作流并获取产物。
智能体设置
测试发布集成凭证。
Webhook
接收操作和项目生命周期事件。