事件上报

通过接口获取token

URL：${url}/edt-api/signature/password_token

请求方式：Post

请求类型：application/json

入参：

参数名	字段名	类型	必填	说明
app_id	产品Id	String	Y
app_secret	产品密钥	String	Y
ip	请求ip	String	Y

返回：

属性	字段名	类型	必填	说明
code	编码	String
msg	描述	String
result	返回结果	String
实体result属性说明
access_token	access_token	String
refresh_token	refresh_token	String

请求格式：

{
  "app_id": "bedde3ab456ac4f7ac16c7bf0ac52d7e46f8a141",
  "app_secret": "aaefb566c4757",
  "ip": "127.0.0.1"
}

返回格式：

{
    "code": 0,
    "msg": "success",
    "result": {
        "access_token": "sign=glkqmbFoR/kRYmYTL++kRjCwgVWz3ZcHe9aZV1MTn2bybXNmml/8zVEVO+2QT0eMGkgpK3bxFJk+woJDNAFTCA==&start_ts=1720418008&end_ts=1720421608&ip=127.0.0.1&payload_enc=pmfcPq2c0fIb0EcdayHlCGWOLcqCD5uttPS+3hbpipHmJFPi34frPuMFpxXAYDUqL9od4Q==",
        "refresh_token": "P2OM4bhCbljjVCdIJn2PhebkgTb9a50XwYH8ITDmpdc="
    }
}

通过接口上报业务事件

URL：${url}/edt-api/push_online/bucket/dc/path/sdk_push/json_bulk

请求方式：Post

请求类型：application/json

请求头header：

Authorization：Bearer + 空格 + 获取token接口返回的access_token

Tenant-Id：租户Id

例如：

Authorization	Bearer sign=glkqmbFoR/kRYmYTL++kRjCwgVWz3ZcHe9aZV1MTn2bybXNmml/8zVEVO+2QT0eMGkgpK3bxFJk+woJDNAFTCA==&start_ts=1720418008&end_ts=1720421608&ip=127.0.0.1&payload_enc=pmfcPq2c0fIb0EcdayHlCGWOLcqCD5uttPS+3hbpipHmJFPi34frPuMFpxXAYDUqL9od4Q==
Tenant-Id	1

入参：

{
    "distinct_id": "qwertyui", // 默认使用用户唯一标识
    "ts": 1721976392000, //事件触发时间
    "apex_id": null, //创略唯一ID（没有默认为null）
    "event_code": "yw_0000014", //事件唯一代码
    "tenant_id": "1", //租户id
    "project_id": "e7b62232-bd6d-4131-96a1-7b8660184a4e", //项目id
    "app_id": "bedde3ab456ac4f7ac16c7bf0ac52d7e46f8a141", //产品id
    "platform": "BusinessSystem", //上报平台 （所属APPID对应的所属平台)
    "common": {
        "event_name": "长龙事件实例", //事件名称
        "event_type": "BusinessSystem", //业务事件默认 BusinessSystem
        "send_type": "interfaceReport", //事件上报方式(业务事件上报默认 interfaceReport)
        "upload_time": 1721976392000 //事件上报时间，接收到埋点事件上报数据的时间
    },
    "extensions":{
        "passengerId": "1222", //用户自行添加的拓展属性
        "plus_card_expired_time": 1721976392000, //用户自行添加的拓展属性
        "business_event_type": "222" //用户自行添加的拓展属性
    }
}

返回：

属性	字段名	类型	必填	说明
data	返回数据	String
success	操作标识	String
code	错误码	String
msg	提示信息	String
requestUrl	请求路径	String
errorMsg		String
errorDetails		String
elapsed	请求响应耗时	Integer
responseStatus		Integer

返回格式：

{
    "data": "[hold for ip]",
    "success": true,
    "code": "",
    "msg": "操作成功",
    "requestUrl": null,
    "errorMsg": null,
    "errorDetails": null,
    "elapsed": 0,
    "responseStatus": 200
}

对接SDK上报埋点事件

URL：${url}/edt-api/push_online/bucket/dc/path/sdk_push/json_bulk

请求方式：Post

请求类型：application/json

请求头header：

Authorization：Bearer + 空格 + 获取token接口返回的access_token

Tenant-Id：租户Id

例如：

Authorization	Bearer sign=glkqmbFoR/kRYmYTL++kRjCwgVWz3ZcHe9aZV1MTn2bybXNmml/8zVEVO+2QT0eMGkgpK3bxFJk+woJDNAFTCA==&start_ts=1720418008&end_ts=1720421608&ip=127.0.0.1&payload_enc=pmfcPq2c0fIb0EcdayHlCGWOLcqCD5uttPS+3hbpipHmJFPi34frPuMFpxXAYDUqL9od4Q==
Tenant-Id	1

入参：

{
    "distinct_id": "6ae3cf0c23d9b41460c46012160c977a",//通过sdk 生成distinctid，作为不用户登录或者未登录时，均上报时候必传字段，在用户登录后，需要传递userid，作为关联业务的字段。
    "ts": 1720419564904,//事件触发时间
    "apex_id": "dc98561a-fe37-4d11-9fc6-c529f3ed77ad",//创略唯一ID
    "event_code": "dc_0000007",//事件唯一代码
    "tenant_id": "1",//租户id
    "project_id": "87627327-14d6-4ba9-865e-ad30791e8124",//项目id
    "app_id": "37e6ea224eb043ac6fa3ddd24ca6e8872a3f0bbb",//产品id
    "platform": "Web",//上报平台
    "common": {
        "message_id": "1",//消息类型编号
        "upload_time": 1720419564905,//事件上报时间，接收到埋点事件上报数据的时间
        "session_id": "session_1719393205682",//同一次会话ID
        "app_version": null,//app版本号
        "app_package_id": null,//app包名
        "mini_program_scene": null,//小程序启动场景
        "market_name": null,//APP下载渠道
        "user_id": null,//账户id，登录后的ID
        "event_code_md5": "8674d92d11d88d97d8790e382269fe9d",//event_code的md5值
        "event_name": "商城首页-商品热销列表-点击",//事件名称
        "event_type": "click",//事件类型
        "send_type": "code",//事件上报方式
        "page_type": "web",//页面类型
        "event_duration": null,//单次使用时长
        "browse_time": null,//事件浏览时长
        "device_id": null,//设备id
        "device_model": null,//设备机型
        "device_brand": null,//设备品牌
        "device_type": "PC",//设备类型
        "device_uuid": null,//通用唯一识别码
        "android_id": null,//安卓设备标识-安卓
        "imei": null,//国际移动设备识别码- 安卓
        "mac": null,//设备mac地址
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36",//浏览器代理（User Agent）
        "idfa": null,//iOS设备的广告标识符
        "idfv": null,//应用开发商标识
        "oaid": null,//信通院统一的第三方设备标识
        "browser_type": "Chrome",//浏览器类型
        "browser_version": "126.0.0.0",//浏览器版本
        "carriers": null,//网络运营商
        "network_type": null,//联网络类别
        "os": "10.0",//操作系统
        "os_system": "Windows",//操作系统
        "os_version": "10.0",//操作系统版本
        "wechat_open_id": null,//微信普通用户的标识
        "wechat_union_id": null,//微信用户统一标识
        "screen_height": 900,//可视窗口的宽度
        "screen_width": 1440,//可视窗口的高度
        "visible_window_width": 1423,//可见窗口宽度
        "visible_window_height": 431,//可见窗口高度
        "page_width": 1423,//可视窗口中页面的宽度
        "page_height": 768,//可视窗口中页面的高度
        "sdk_version": "0.1.0",//sdk版本号
        "sdk_type": "JS",//sdk类型
        "referrer_url": null,//站外地址
        "referrer_host": null,//站外域名
        "utm_matching_type": null,//广告渠道追踪匹配模式
        "utm_source": null,//广告系列来源
        "utm_medium": null,//广告系列媒介
        "utm_term": null,//广告系列字词
        "utm_content": null,//广告系列内容
        "utm_campaign": null,//广告系列名称
        "ip": "10.25.19.102",//ip地址
        "latitude": null,//纬度
        "longitude": null,//经度
        "province": null,//省
        "city": null,//市
        "country": null,//国家
        "province_id": null,省份Id
        "city_id": null,//城市Id
        "county": null,//县区
        "current_page_id": "index_id",//当前页面page_id
        "current_page_name": "index",//当前页面名称
        "current_page_url": "http://10.25.19.102:8010/",//当前页面完整链接
        "current_page_host": "10.25.19.102:8010",//当前页面主机域名
        "current_page_query": null,//当前页面参数
        "current_page_path": "/",//当前页面路径
        "source_page_id": "prod",//上级来源页面page_id
        "source_page_name": "创略商城",//来源页面名称
        "source_page_url": "http://10.25.19.102:8010/pages/prod/prod?prodid=198",//上级来源页面完整链接
        "source_page_host": null,//上级来源页面主机域名
        "source_page_query": "?prodid=198",//上级来源页面参数
        "source_page_path": "/pages/prod/prod",//上级来源页面路径
        "time_since_last_operation": 1040512,//距离上次操作的时间
        "page_X": "448",//鼠标所处绝对坐标的X值
        "page_Y": "500",//鼠标所处绝对坐标的Y值
        "client_X": "448",//鼠标所处相对坐标的X值
        "client_Y": "247",//鼠标所处相对坐标的Y值
        "element_id": null,//元素ID
        "element_name": null,//元素名称
        "element_target_url": null,//元素链接地址
        "element_type": null,//元素类型
        "element_content": null,//元素内容
        "element_selector": null,//元素选择器
        "element_position": null,//元素位置
        "element_index": null,//元素所在位置索引
        "element_tag_name": null,//元素标签名
        "element_class": null,//元素样式名
        "element_path": null,//元素路径
        "write_log_time": 1720418524392,//埋点事件数据写入到日志的时间
        "insert_db_time": 1720418524392,//埋点事件数据写入到数据库的时间
        "track_signup_original_id": "",//关联原始id
        "last_visit_time": "",//未次访问时间
        "is_first_time": "",//是否首次使用应用
        "forward_user_id": "",//登录时候存的前向id
        "ts": 1720419564904,//事件触发时间
        "is_click": true//是否点击
    },
    "extensions": {
        "prodid": 201//扩展字段
    }
}

返回：

属性	字段名	类型	必填	说明
data	返回数据	String
success	操作标识	String
code	错误码	String
msg	提示信息	String
requestUrl	请求路径	String
errorMsg		String
errorDetails		String
elapsed	请求响应耗时	Integer
responseStatus		Integer

返回格式：

{
    "data": "[hold for ip]",
    "success": true,
    "code": "",
    "msg": "操作成功",
    "requestUrl": null,
    "errorMsg": null,
    "errorDetails": null,
    "elapsed": 0,
    "responseStatus": 200
}