只读 API
分析 API
读取个人令牌可访问项目的分析数据。
GET
/api/domains/{host}/agent-analytics接口#
GET /api/domains/{host}/agent-analytics
基础地址为 https://app.keptai.com。通过 Authorization: Bearer 请求头发送个人令牌。
参数#
| 参数 | 有效值 |
|---|---|
| host(路径) | 项目域名,不含协议或路径。 |
| section | 下列 17 个 section 之一;省略时请求组合视图。 |
| days | 7、30 或 90;默认 30。 |
| engine | 支持的引擎标识,可用逗号分隔多个值。 |
| topic、category、brand | 可选,使用 scope-options 返回的值,多个值以逗号分隔。 |
包含空格或标点的值需要 URL 编码。通过筛选选项获取项目有效值;不支持按用户画像或国家筛选。
数据分区#
- 核心指标、趋势与领先品牌 —
overview。 - 品牌洞察摘要 —
insights。 - 品牌感知摘要 —
perception。 - 提示词列表与账号额度信息 —
prompts。 - 引用来源域名 —
domains。 - 引用来源 URL —
urls。 - 与竞争对手的引用差距 —
gaps。 - 观测到的爬取活动 —
crawl。 - 可用的可爬取性分析 —
crawlability。 - 观测到的转化分析 —
conversions。 - 可用的优化任务分析 —
actions。 - 可用的影响分析 —
impact。 - 品牌排名分析 —
ranking。 - 采样答案与对话分析 —
chats。 - 查询扩展观测数据 —
fanouts。 - 网页搜索界面中的广告观测数据 —
ads。 - 购物观测数据 —
shopping。
请求示例#
curl --fail-with-body 'https://app.keptai.com/api/domains/example.com/agent-analytics?section=overview&days=30' \
-H "Authorization: Bearer $KEPT_API_TOKEN"
const response = await fetch(
'https://app.keptai.com/api/domains/example.com/agent-analytics?section=overview&days=30',
{ headers: { Authorization: `Bearer ${process.env.KEPT_API_TOKEN}` } }
);
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);
import json, os, urllib.request
request = urllib.request.Request(
'https://app.keptai.com/api/domains/example.com/agent-analytics?section=overview&days=30',
headers={'Authorization': 'Bearer ' + os.environ['KEPT_API_TOKEN']}
)
with urllib.request.urlopen(request) as response:
print(json.load(response))
解读响应#
响应为 JSON,保留对应 section 在应用中的数据结构。不要假设所有分区都有相同的 rows 字段。数据缺失或为空可能与采样不足、域名未接入 Gateway 等情况有关。请核对返回数据及可用性信息,不要直接将缺失值当作零。
访问范围和错误处理请参考身份验证。