数据监控 - 数据埋点 API 文档
所有项目
请求 URL:
/monitor/dc/{project}
请求方式:
GET POST
project项目名称:
参数名称 | 项目名 |
---|---|
opinion | 舆情 |
job | 职场 |
ai | AI项目 |
newsfeed | 资讯业务 |
请求参数
参数名称 | 是否必要 | 类型 | 说明 | 示例值 |
---|---|---|---|---|
uid | 可选 | String | 登录后的接口的 userid | "1" |
session | Server | String | 用于标识唯一用户的 UUID,长度为 16 | 22bc0fd9-f866-49 |
client_ip | Server | String | 客户端 IP | 192.1.1.1 |
client | 必要 | String | 设备类型 | webapp、wechat、web、android、ios、miniprogram |
url | 可选 | String | 页面地址 Web 直接“/”开头,APP 传入类名 | "/example-path" |
referer | 可选 | String | 上个页面页面地址 Web 直接“/”开头 APP 可忽略 | "/example-path" |
timestamps | 必要 | String | 触发时间 new Date().toISOString() | "2023-10-17T07:21:55.335Z" |
page_name | 必要 | String | 页面名称["我的关注", "行业热点", "新闻详情", "舆情设置"] | "我的关注" |
event | 必要 | String | 事件描述["点击", "跳转"] | "点击" |
target | 必要 | String | 表示用户点击的按钮或者 Tab 的描述["登录", "注册", "舆情", "我的关注", "去设置关键词", "保存", "关注微信", "定制报告", "查看全文"] | "登录" |
ua | Server | String | 请求头,服务端自动获取 | - |
返回示例
{
"errno": 0,
"msg": "success"
}
返回参数说明
参数名称 | 类型 | 说明 |
---|---|---|
errno | Number | 错误码 |
msg | String | 消息描述 |
备注
- 当
uid
为空时,session
可以用来标识唯一用户。 client_ip
和client
参数由服务端自动获取和解析,无需客户端传入,Android 和 IOS 需要调试。- 更多细节和解释可以参考上面的注释说明。