HTTP API(SaaS查看）

说明：

• 服务端上报的http接口增长分析平台为您默认开通，如果您接入的应用没有开通，请联系客户成功经理解决；
• 本文档针对的是SaaS版本的产品，私有化版本请参考私有化的文档：Http API （私有化）
• 使用此功能之前，建议您先阅读数据格式 和数据质量文档说明避免上报细节错误。

1.请求接口

单条数据上传：

• Path: https://mcs.ctobsnssdk.com/v2/event/json
• Method: POST

多条数据上传（每次最多20条）：

• Path: https://mcs.ctobsnssdk.com/v2/event/list
• Method: POST

2.请求规范

(1) 请求的header里带"Content-Type: application/json"，以及“X-MCS-AppKey”，作为app的标识；
(2) 请求的body包含user，header，event三个部分，其中的header是埋点数据本身的header；
(3) 单次上传events数控制在20条以内，超过50条会报413；
(4) 上传如采用/v2/event/list接口，json数目控制在20条以内，超过50条会报413。

2.1 请求header

APP Key的获取位置请参考以下截图

2.2 请求body

2.3 user格式

2.4 header格式

2.5 event格式

3.HTTP Response 格式

HTTP 状态码

4.请求示例

4.1 /v2/event/json接口

curl -X POST -H "Content-Type: application/json" -H "X-MCS-AppKey: 12345678key" -d '{"user": {...}, "header":{...}, "events":{...}}' https://mcs.ctobsnssdk.com/v2/event/list

请求body：

{
    "user": {
            // 建议先在客户端上报用户的user_unique_id，然后再在服务端使用
        "user_unique_id": "74481585297"   //用户唯一标示
    },
    "header": {
        "ab_sdk_version": "91223,83097",   //AB实验vid
        "app_channel": "App Store",    //App渠道
        "app_name": "news_article",    //App名称
        "app_package": "com.ss.android.article.news",   //App包名
        "app_version": "5.1.3",        //App版本
        "client_ip": "10.100.1.1",     //客户端ip地址
        "device_model": "SM-G9250",    //设备型号
        "os_name": "Android",          //操作系统
        "os_version": "6.0.1",         //操作系统版本
        "traffic_type": "app",
        "custom":"{\"common_param1\":\"value1\"}"         //事件公共属性
    },
    "events": [
        {
            "ab_sdk_version": "91223,83097",   //AB实验vid
            "event": "test_go_detail",    //事件名称
            "params": "{\"paramName\":\"a\"}",    //事件属性
            "local_time_ms": 1489573628001   //事件发生的时间戳
        }
    ]
}

4.2 /v2/event/list接口

curl -X POST -H "Content-Type: application/json" -H "X-MCS-AppKey: 12345678key" -d '[{"user": {...}, "header":{...}, "events":{...}}]  https://mcs.ctobsnssdk.com/v2/event/list

请求body：

[{
    "user": {
        "user_unique_id": "74481585297"   //用户唯一标示
    },
    "header": {
        "ab_sdk_version": "91223,83097",   //AB实验vid
        "app_channel": "App Store",    //App渠道
        "app_name": "news_article",    //App名称
        "app_package": "com.ss.android.article.news",   //App包名
        "app_version": "5.1.3",        //App版本
        "client_ip": "10.100.1.1",     //客户端ip地址
        "device_model": "SM-G9250",    //设备型号
        "os_name": "Android",          //操作系统
        "os_version": "6.0.1",         //操作系统版本
        "traffic_type": "app"
    },
    "events": [
        {
            "event": "test_go_detail",    //事件名称
            "params": "{\"paramName\":\"a\"}",    //事件属性
            "local_time_ms": 1489573628001   //事件发生的时间戳
        }
    ]
}]

5.导入历史数据

注意历史数据导入需要隔天才能查看

如需导入历史数据，需在header的custom字段中增加历史数据的标识__is_history且属性值设置为字符串"true"；上报示例如下：

[{
   "user": {
       "user_unique_id": "74481585297"   //用户唯一标示
   },
   "header": {
       //导入历史数据标识，不填默认为非历史数据
       //is_vip、mp_platform等属性为自定义的事件公共属性，用户可按需填写
       "custom": "{\"__is_history\":\"true\",\"is_vip\":\"2\",\"vip_level\":\"3\"}"
   },
   "events": [
       {
           "event": "test_go_detail",    //事件名称
           "params": "{\"paramName\":\"a\"}",    //事件属性
           "local_time_ms": 1489573628001   //事件发生的时间戳
       }
   ]
}]

6.上报数据限制

请参考文档：

• 数据格式文档中的数据上报限制：数据格式
• 数据质量：“数据质量”

7. 验证数据上报成功

方式1 ： 可以在“高级分析”--> “自定义SQL”里直接查询
方式2： 如果知道特定的user_unique_id，可以在行为细查里查询
方式3： 可以在事件分析页面进行查询分析

8. 常见问题

1、如果有服务端上报设备 id 的需求，需要上传 bddid，而不是 bd_did（客户端是这个格式）。

[{
    "user": {
        "user_unique_id": "123456",   
           "bddid":"4HB6O2XULLZHT3KOCSENP3UJSK2ULY24NNCMFMT6PBNEQZNVJ35A01"
    },
    "header": {

    },
    "events": [
        {
            "event": "test_go_detail",    //事件名称
            "params": "{\"paramName\":\"a\"}",    //事件属性
            "local_time_ms": 1489573628001   //事件发生的时间戳
        }
    ]
}]

2. 如果有上报自定义公共属性的需求，请参考 文档“ User Profile API（服务端-SaaS）”章节