默认事件埋点

ℹ️

默认事件接入说明

为了方便埋点，我们提供以下默认事件直接使用：

安装事件
打开事件
注册事件
点击事件

安装事件

事件名称：install
使用场景：

安装事件代表这个APP在设备上为首次打开。为了记录此安装事件，建议将此接口配置在APP开启的生命周期函数当中。为了区分安装事件和打开事件，建议你定义一个布尔值变量is_open=False。如果，此变量为false则为第一次打开，记录为安装事件，如果为true则为非首次打开，记录为打开事件。你也可以采取更为方便的方式来设计此事件。

请求示例：

{
    "project": "项目ID",
    "request_id": "uuid",
    "timestamp": 1696867200000,
    "msg_signature": "hash id",
    "event": "install",
    "user_data": {
        //... 【请查看事件埋点接入指南参数说明】
    }
}

参数说明

参数	必须	类型	说明
project	是	string	智链Dashboard后台项目管理页中获取到的`项目ID`
request_id	是	string	请求唯一id
timestamp	是	int64	当前时间戳(毫秒)
msg_signature	是	string	sha1(project+”_“+request_id+”_“+timestamp+”_“+AppSecret) AppSecret获取方法：AppSecret
event	是	string	固定传入`install`
user_data	是	object	用户数据，详细参数请阅读事件埋点接入指南参数说明

返回示例

打开事件

事件名称：open
使用场景：

打开事件代表这APP被打开。为了记录此打开事件，建议将此接口配置在APP开启的生命周期函数当中。

请求示例：

{
    "project": "项目ID",
    "request_id": "uuid",
    "timestamp": 1696867200000,
    "msg_signature": "hash id",
    "event": "open",
    "user_data": {
        //... 【请查看事件埋点接入指南参数说明】
    }
}

参数说明

参数	必须	类型	说明
project	是	string	智链Dashboard后台项目管理页中获取到的`项目ID`
request_id	是	string	请求唯一id
timestamp	是	int64	当前时间戳(毫秒)
msg_signature	是	string	sha1(project+”_“+request_id+”_“+timestamp+”_“+AppSecret) AppSecret获取方法：AppSecret
event	是	string	固定传入`open`
user_data	是	object	用户数据，详细参数请阅读事件埋点接入指南参数说明

返回示例

注册事件

事件名称：register
使用场景：

用户注册事件。

请求示例：

{
    "project": "项目ID",
    "request_id": "uuid",
    "timestamp": 1696867200000,
    "msg_signature": "hash id",
    "event": "register",
    "user_data": {
        //... 【请查看事件埋点接入指南参数说明】
    }
}

参数说明

参数	必须	类型	说明
project	是	string	智链Dashboard后台项目管理页中获取到的`项目ID`
request_id	是	string	请求唯一id
timestamp	是	int64	当前时间戳(毫秒)
msg_signature	是	string	sha1(project+”_“+request_id+”_“+timestamp+”_“+AppSecret) AppSecret获取方法：AppSecret
event	是	string	固定传入`register`
user_data	是	object	用户数据，详细参数请阅读事件埋点接入指南参数说明

返回示例

点击事件

事件名称：click
使用场景：

指定链接被点击事件上报，返回的LinkData数据为该制定链接的LinkData数据。通常作用于app内部记录渠道点击次数同时获取该链接LinkData做后续操作，如根据LinkData内容跳转指定页面等。

请求示例：

{
    "project": "项目ID",
    "request_id": "uuid",
    "timestamp": 1696867200000,
    "msg_signature": "hash id",
    "event": "click",
    "user_data": {
        //... 【请查看事件埋点接入指南参数说明】
    },
    "event_data": {
        "click_link_id": "链接hash值"
    },
}

参数说明

参数	必须	类型	说明
project	是	string	智链Dashboard后台项目管理页中获取到的`项目ID`
request_id	是	string	请求唯一id
timestamp	是	int64	当前时间戳(毫秒)
msg_signature	是	string	sha1(project+”_“+request_id+”_“+timestamp+”_“+AppSecret) AppSecret获取方法：AppSecret
event	是	string	固定传入`click`
user_data	是	object	用户数据，详细参数请阅读事件埋点接入指南参数说明
event_data.click_link_id	是	string	深度链接hash值

返回示例

返回编码(code)说明

API返回编码说明