一般不需要手写这条请求,浏览器脚本会替你发,脚本安装见 JavaScript(w.js)。自己实现采集端时,按下面的规则组织载荷。
端点
https://app.tapcub.com/api/v1/pulse 采集浏览器事件
公开的采集端点(由网关转到采集进程,不是 API 进程)。恒返回 202。结构性错误(JSON 无法解析、缺少 v/s/t、u 不是 http(s)、t=id 没有合法 op、t=ac 没有合法 k)也保持 202 且响应体为空。页面浏览可能带回采集配置 JSON(Content-Type 为 application/json);其它成功响应体为空。批量可以是裸数组(最多 50 条,多出的丢掉)或 { sent, items }。没有 API Key:站点由每条里的 s(站点密钥)标识。
请求体 application/json必填
响应
- 202已接收。响应体为空;页面浏览生成了配置时则为采集配置对象。
响应字段 202
tinteger本次请求的采集档位
123
cinteger加载客服脚本
1
xinteger加载身份扩展脚本
1
iinteger识别模式
1
ainteger自动采集
1
hinteger识别前先暂存事件
1
cninteger国内模式回显,给应用 SDK
1
aoobjecttextbooleansamplenumberdenystring[]formsbooleanscrollbooleanflushintegerbatchintegerisstring身份来源
csobjectreqbooleanpurposesstring[]prestringverstringcnintegerrejintegerrcobject非网站 SDK 的非默认远程配置
rpobject会话回放:s 为采样百分比,u 为脚本地址
snumbermtintegermiintegerustringexstring[]响应带 Cache-Control: no-store。除了结构性错误,站点未知或暂停、IP 或站点标识被封禁、超过采集频率也都是 202 空体,只丢掉这条并计数。请求体上限 64 KB,超出时框架在进入处理函数之前就拒绝(413)。
带发送时间的批量包装:
{ "sent": 1759363200123, "items": [ { "v": 1, "s": "站点标识", "t": "pv", "u": "https://example.com/" } ] }sent 是客户端发送时刻的毫秒,和每条的 ts 一起用来校正时钟。与服务器相差超过 24 小时则改用到达时间。
载荷规则
字段表由契约渲染。下面是决定一条事件是否被收下的规则:
v为1或2;did、sid、mid、ts在版本 2 使用。t为ev时需要事件名n;为id时必须有合法的op;为ac时必须有合法的k。p是扁平属性,值只能是字符串、数字或布尔。- 可选字段超长时会被截断或降级,事件仍然收下,不会因为一个可选字段整条丢掉。
第一条 pv 的响应体是配置 JSON,键是短名,供脚本决定是否加载身份、同意和回放。它不是开放查询那种 data 信封。
读取配置
https://app.tapcub.com/api/v1/pulse/cfg 拉取采集配置
公开接口。SDK 初始化时拉取站点配置,不写事件。s 是站点密钥(8–32 个字符)。pt 是可选的 SDK 平台,不传则为 web。未知、已暂停或暂时不可用的站点返回 404 且响应体为空。JSON 是采集配置;没有扩展项的网站仍可能只返回 { t }。
查询参数2
sstring必填站点密钥。
ptstringSDK 平台。无法识别时按 web。
webmp_weixinmp_alipaymp_bytedancemp_baidump_kuaishou
响应
- 200采集配置
- 404站点未知或已暂停,或采集端暂时无法回答。响应体为空。
响应字段 200
tinteger本次请求的采集档位
123
cinteger加载客服脚本
1
xinteger加载身份扩展脚本
1
iinteger识别模式
1
ainteger自动采集
1
hinteger识别前先暂存事件
1
cninteger国内模式回显,给应用 SDK
1
aoobjecttextbooleansamplenumberdenystring[]formsbooleanscrollbooleanflushintegerbatchintegerisstring身份来源
csobjectreqbooleanpurposesstring[]prestringverstringcnintegerrejintegerrcobject非网站 SDK 的非默认远程配置
rpobject会话回放:s 为采样百分比,u 为脚本地址
snumbermtintegermiintegerustringexstring[]不写事件、不读设备、不落库,只按 IP 所在国家给出合规档位。
相关路径
采集频率见 速率限制。回放分片走另一条 POST /api/v1/replay:校验通过返回 204;会话超出配额或站点已关回放时返回 200,体为 {"stop":1}。
脚本请指向控制台安装代码里给出的采集域名。