只读 API

分析 API

读取个人令牌可访问项目的分析数据。

GET/api/domains/{host}/agent-analytics

接口#

http
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 编码。通过筛选选项获取项目有效值;不支持按用户画像或国家筛选。

数据分区#

请求示例#

cURL
curl --fail-with-body 'https://app.keptai.com/api/domains/example.com/agent-analytics?section=overview&days=30' \
  -H "Authorization: Bearer $KEPT_API_TOKEN"

解读响应#

响应为 JSON,保留对应 section 在应用中的数据结构。不要假设所有分区都有相同的 rows 字段。数据缺失或为空可能与采样不足、域名未接入 Gateway 等情况有关。请核对返回数据及可用性信息,不要直接将缺失值当作零。

访问范围和错误处理请参考身份验证

搜索标题、指南和 API 参考。