1. 请求的header里带"Content-Type: application/json"以及“X-MCS-AppKey”，作为app的标识。
   • 通过http api上报时，如果用代码及一些工具时，一般请求头上会自动带上User-Agent字段（用于标识发起请求的客户端软件的信息，不影响调研API的结果）。
   • 如果手动发送可能会提示User-Agent is not allowed，则需要手动在请求头上加入User-Agent字段，此场景下，您可以随机填写一个user-Agent字段的取值，或先使用类似Postman等工具调用一下API，复制其中的user-Agent取值。
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格式

user部分用于设置用户的唯一标识，当前DataFinder支持使用 device_id、user_unique_id、ssid 三种 id 标识设备和用户，同时SaaS-云原生、私有化环境支持使用多ID口径来更加准确的标识一个用户，更多关于用户唯一标识详细介绍可参见支持的用户唯一标识，以下为使用HTTP API上报用户唯一标识的相关字段。

2.4 header格式

2.5 event格式

4.1 /v2/event/json接口

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

请求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":"{\"A\":\"a\"}"         //事件公共属性
    },
    "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://gator.volces.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   //事件发生时刻的时间戳
        }
    ]
}]

多ID口径上报：如果上报应用使用了多口径ID，则需要在上报用户信息（user字段）时除user_unique_id外，同时携带user_unique_id_type，示例代码如下。

"user": {
        "user_unique_id": "13388999999"   //用户唯一标示值
        "user_unique_id_type": "phone"   //值为id code, 小写，具体值有ID涉及方案提供
    }

用户属性是通过特殊的事件进行上报，通过设置下面几个event可以修改用户属性：

5.1 上报用户属性

用户属性放在params中

• 通用请求示例：作用为设置一个用户属性age，删除一个用户属性name，body：

  {
      "user": {
          "user_unique_id": "74481585297"   //用户唯一标示
      },
      "header": { // 无必填项，app_id 由 appkey确认
         
      },
      "events": [
          {
              "event": "__profile_set",    //操作名
              "params": "{\"age\": 10}",    //设置属性
              "local_time_ms": 1489573628001   //事件发生的时间戳
          },
          {
              "event": "__profile_unset",    //操作名
              "params": "{\"name\":\"tom\"}",    //设置属性
              "local_time_ms": 1489573628001   //事件发生的时间戳
          }
      ]
  }
  

• 多ID口径上报示例：如果上报应用使用了多口径ID，则需要在上报用户信息（user字段）时除user_unique_id外，同时携带user_unique_id_type。

  "user": {
          "user_unique_id": "13388999999"   //用户唯一标示值
          "user_unique_id_type": "phone"   // 值为id code, 具体值有ID涉及方案提供
      }
  

  说明

  更多多ID口径的介绍和使用指导请参见使用多ID类型。

5.2 批量上报用户属性

当需要批量上报用户属性时，可以在params里加上一个特殊字段__uuid_list来实现，__uuid_list是一个user_unique_id的列表，params中除__uuid_list字段的其他字段作为这个__uuid_list中所有user_unique_id的属性，参考代码：

{
    "user": {
        "user_unique_id": "user1"
    },
    "header":{"app_name":"init","app_id":"10000000"},
    "events": [
        {
            "event": "__profile_set",
            "params": {
                "__uuid_list": ["user1", "user2", "user3", "user4"],
                "age":20
            }
        }
    ]
}

5.3 验证上报的用户属性

可以在行为细查页面中查看特定用户的数据，如果是大量数据，可以在事件分析中对用户属性进行分析。

6.1 创建业务对象

创建业务对象之后需要等待5-10分钟之后再上报；
每个应用目前最多可创建10个业务对象；每个业务对象最多可创建50个属性；

前提条件

在进行业务维度数据接入前，您需要先根据业务情况，规划好需要分析的业务维度有哪些、每个业务维度需要有哪些属性，并在DataFinder的数据管理中创建好对应的业务维度。后续数据接入的业务维度和属性数据需与已添加的业务维度信息保持一致。添加业务维度的操作请参见业务维度。
业务对象内置的id属性，对应的字段名称为item_id，因此不需要再定义一个 id 属性。

配置上报业务对象

业务对象属性是通过特殊的事件进行上报，通过设置下面几个event可以修改业务对象属性：

业务对象属性放在params中，并且需要有item_name和item_id来标识唯一业务对象。
示例请求body：

{
    "user": {
            "user_unique_id": "__rangers"   // 业务对象上报，固定为__rangers
    },
    "header": {
        "app_name": "news_article"//App名称
    },
    "events": [
        {
            "event": "__item_set",    //操作名
            "params": "{\"item_name\":\"phone\",\"item_id\":\"1\",\"price\": 1000}",    //设置属性
            "local_time_ms": 1489573628001   //事件发生的时间戳
        }
    ]
}

6.2 上报关联事件

前提条件

已在数据管理>业务维度页面添加业务维度；并已完成上述步骤：创建业务对象。

配置item与事件关联

创建好的 item 对象需要与事件关联才可以使用。您需要在配置数据接入时，同时配置好业务维度和事件数据的关联规则，即将某一个或多个具体item的item id 值配置到事件的预置属性params.__items当中。
下列示例代码演示了将 sku 和 order 两个创建好的业务维度与事件 new_order 进行关联的方式。__items 为事件预置属性，仅用于上报业务维度。
示例如下：

...
"event": "new_order",
"params": {
    "__items": "[{\"sku\":[{\"id\":\"sku_id_1\"},{\"id\":\"sku_id_2\"}]},{\"order\":[{\"id\":\"order_id_1\"},{\"id\":\"order_id_2\"}]}]",
    ...
},
...

__items 是转为 string 的 json 对象，其格式为：

[
    {"item_name_1": [
        {"id": "id_value_1"},
        {"id": "id_value_2"},
        ...
    ]},
    {"item_name_2": [
        {"id": "id_value_1"},
        {"id": "id_value_2"},
        ...
    ]}
]

item_name_1 就是在上一步中定义的业务维度名称，例如order；id_value_1、id_value_2即为item id的取值，例如订单号id1、订单号2。

如果数据的客户端时间超过七天，正常情况下无法导入。如需导入历史数据，需在header的custom字段中增加历史数据的标识__is_history，属性值设置为字符串"true"。
上报示例如下：

[{
   "user": {
       "user_unique_id": "74481585297"   //用户唯一标示
   },
   "header": {

       "custom": {
              "__is_history": "true" //导入历史数据标识，默认为false;
       }
   },
   "events": [
       {
           "event": "test_go_detail",    //事件名称
           "params": "{\"paramName\":\"a\"}",    //事件属性
           "local_time_ms": 1489573628001   //事件发生时刻的时间戳
       }
   ]
}]

上报完成后，需要在界面上点击刷新数据，即可查询到上报的历史数据。

请参考文档：

• 数据格式文档中的数据上报限制：数据格式
• 数据治理看板：数据治理看板

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