用户 API-个推文档中心

当前位置：用户运营 > 服务端 > RestAPI > 用户API

用户 API

简述

开发者可以通过开放接口实现特定功能需求。

【用户导入】事件埋点数据导入

开发者可将自有历史埋点数据导入到运营工具，用于页面分析。
注意事项：
1.对于满足运营工具标准数据结构且数据量较小的场景，可通过API方式导入数据；对于异构数据或数据量较大的场景，请联系技术支持。
2.为了不影响正常SDK采集上报的数据，默认只允许导入SDK已上报gtcid的埋点数据，如果有全量gtcid导入的场景诉求，请联系技术支持。

接口定义

接口地址: $BaseUrl/import/event
请求方式: POST
content-type:application/json;charset=utf-8

Request请求说明

Header参数说明

名称	类型	是否必须	默认值	描述
token	`String`	是	无	接口访问凭据，获取方式请参考获取鉴权token

body参数说明

入参字段定义

名称	类型	是否必须	默认值	描述
dataList	`List<EventDataDTO>`	是	无	客户埋点数据列表，size最大支持200,EventDataDTO字段描述详见下方EventDataDTO说明

EventDataDTO说明

名称	类型	是否必须	默认值	描述
gtcid	`String`	是	无	个推标识id
sessionId	`String`	否	UUID	会话id，不填影响路径分析统计准确性
datetime	`String`	是	无	埋点发生时间，ms级时间戳，对于当日事件数据，导入后即可在当天参与分析。对于历史事件数据，在T+2天后可参与分析
eventId	`String`	是	无	事件id
properties	`Json`	是	无	事件属性值列表，包含预置及自定义属性，预置属性详见事件预置属性说明

properties字段说明
由于业务计算强依赖$app_type（应用类型）、$os（平台类型），因此在数据导入时properties字段中必须携带以上属性。
app_type枚举：app、mp、h5，分别表示app应用、小程序、web。

入参示例

{
  "dataList": [
    {
      "gtcid": "gtcid1",            // 个推标识id，必传
      "datetime": "1712646657000",            // 埋点发生时间，必填
      "eventId": "eventId1",             // 事件id，必填
      "properties": {            // 属性值列表，必填
        "$app_type": "app",             // 应用类型
        "$os": "android",            // 平台类型
        "$firstvisittime":"",             // 首次访问时间
        "$uid": "",             // 自定义用户id
        "自定义属性名称1": "yyyy-MM-dd hh:mm:ss",              //自定义属性,值类型：date
        "自定义属性名称2": true,              // 值类型：boolean
        "自定义属性名称3": "",             // 值类型：string
        "自定义属性名称4": 0,              // 值类型：number
        ...
      }
    }
  ]
}

Response响应说明

http code: 200(http code码说明)
正常响应出参示例

{
  "msg": "成功",              // 响应信息
  "code": 0               // 响应code码
}

请求示例

curl $BaseUrl/import/event \
-X POST \
-H "Content-Type: application/json;charset=utf-8" \
-H "token: $token" \
-d '{
  "dataList": [
    {
      "gtcid": "gtcid1",
      "datetime": "1704074400000",
      "eventId": "eventId1",
      "properties": {
        "$app_type": "app",
        "$os": "android",
        "$firstvisittime":"2024-01-91 10:00:00",
        "$uid": "uid1",
        "自定义属性名称1": "2024-01-91 10:00:00",
        "自定义属性名称2": true,
        "自定义属性名称3": "",
        "自定义属性名称4": 0
      }
    }
  ]
}'

【用户导入】用户埋点数据导入

开发者可将自有历史埋点数据导入到运营工具，用于页面分析。
注意事项：
1.对于满足运营工具标准数据结构且数据量较小的场景，可通过API方式导入数据；对于异构数据或数据量较大的场景，请联系技术支持。
2.为了不影响正常SDK采集上报的数据，默认只允许导入SDK已上报gtcid的埋点数据，如果有全量gtcid导入的场景诉求，请联系技术支持。

接口定义

接口地址: $BaseUrl/import/user
请求方式: POST
content-type:application/json;charset=utf-8

Request请求说明

Header参数说明

名称	类型	是否必须	默认值	描述
token	`String`	是	无	接口访问凭据，获取方式请参考获取鉴权token

body参数说明

入参字段定义

名称	类型	是否必须	默认值	描述
dataList	`List<UserDataDTO>`	是	无	客户埋点数据列表，size最大支持200,UserDataDTO字段描述详见下方UserDataDTO说明

UserDataDTO说明

名称	类型	是否必须	默认值	描述
gtcid	`String`	是	无	个推标识id
datetime	`String`	是	无	埋点发生时间，ms级时间戳
properties	`Json`	是	无	用户属性值列表，包含预置及自定义属性，预置属性详见用户预置属性说明

入参示例

{
  "dataList": [
    {
      "gtcid": "gtcid1",              // 个推标识id，必传
      "datetime": "1712646657000",              // 埋点发生时间，必填
      "properties": {              // 属性值列表，必填
        "$app_type": "app",              // 应用类型
        "$os": "android",              // 平台类型
        "$firstvisittime":"",              // 首次访问时间
        "$uid": "",              // 自定义用户id
        "自定义属性名称1": "yyyy-MM-dd hh:mm:ss",              // 自定义属性，值类型：date
        "自定义属性名称2": true,              // 值类型：boolean
        "自定义属性名称3": "",              // 值类型：string
        "自定义属性名称4": 0,              // 值类型：number
        ...
      }
    }
  ]
}

Response响应说明

http code: 200(http code码说明)
正常响应出参示例

{
  "msg": "成功",              // 响应信息
  "code": 0              // 响应code码
}

请求示例

curl $BaseUrl/import/user \
-X POST \
-H "Content-Type: application/json;charset=utf-8" \
-H "token: $token" \
-d '{
  "dataList": [
    {
      "gtcid": "gtcid1",
      "datetime": "1704074400000",
      "properties": {
        "$app_type": "app",
        "$os": "android",
        "$firstvisittime":"2024-01-91 10:00:00",
        "$uid": "uid1",
        "自定义属性名称1": "2024-01-91 10:00:00",
        "自定义属性名称2": true,
        "自定义属性名称3": "",
        "自定义属性名称4": 0
      }
    }
  ]
}'

【用户导出】用户群列表查询

开发者可以通过该接口获取用户群列表信息。
说明：该功能为 VIP 功能，若须使用请点击右侧“技术咨询”了解详情。

接口定义

接口地址: $BaseUrl/export/crowd/exportableCrowdList
请求方式: POST
content-type:application/json;charset=utf-8

Request请求说明

Header参数说明

名称	类型	是否必须	默认值	描述
token	`String`	是	无	接口访问凭据，获取方式请参考获取鉴权token

Response响应说明

出参data字段定义

名称	类型	是否必须	默认值	描述
list	`List<Object>`	否	无	用户群列表,目前最大size=100
total	`Long`	否	无	用户群列表数量

http code: 200(http code码说明)
正常响应出参示例

{
  "data": {
    "list": [              // 用户群列表
      {
        "crowdId": "CROWD_yyyy-MM-dd_XXX",               // 用户群id
        "crowdName": "用户群1"              // 用户群名称
      }
    ],
    "total": 100              // 列表数量
  },
  "code": "0",               // 响应code码
  "msg": "成功"               // 响应信息
}

请求示例

curl $BaseUrl/export/crowd/exportableCrowdList\
-X POST \
-H "Content-Type: application/json;charset=utf-8" \
-H "token: $token" \
-d '{}'

【用户导出】创建用户群导出任务

开发者可以通过该接口创建用户群导出任务。
说明：该功能为 VIP 功能，若须使用请点击右侧“技术咨询”了解详情。

接口定义

接口地址: $BaseUrl/export/crowd/createCrowdExportTask
请求方式: POST
content-type:application/json;charset=utf-8

Request请求说明

Header参数说明

名称	类型	是否必须	默认值	描述
token	`String`	是	无	接口访问凭据，获取方式请参考获取鉴权token

body参数说明

入参字段定义

名称	类型	是否必须	默认值	描述
crowdId	`String`	是	无	用户群id
uidType	`String`	是	无	导出ID类型，目前支持`CID`和`GTCID`,大小写敏感。`CID`仅在创建用户群时对接推送或文件上传`CID`创建用户群时支持

入参示例

{
  "crowdId": "CROWD_yyyy-MM-dd_XXX",
  "uidType": "GTCID"
}

Response响应说明

出参data字段定义

名称	类型	是否必须	默认值	描述
taskId	`Long`	否	无	任务id

http code: 200(http code码说明)
正常响应出参示例

{
  "data": {
    "taskId": 1001                // 任务id
  },
  "code": "0",               // 响应code码
  "msg": "成功"                // 响应信息
}

请求示例

curl $BaseUrl/export/crowd/createCrowdExportTask\
-X POST \
-H "Content-Type: application/json;charset=utf-8" \
-H "token: $token" \
-d '{
    "crowdId": "CROWD_yyyy-MM-dd_XXX",
    "uidType": "GTCID"
}'

【用户导出】查询用户群导出任务状态

开发者可以通过该接口获取到用户群导出任务的状态。
说明：该功能为 VIP 功能，若须使用请点击右侧“技术咨询”了解详情。

接口定义

接口地址: $BaseUrl/export/crowd/exportCrowdTaskStatus
请求方式: POST
content-type:application/json;charset=utf-8

Request请求说明

Header参数说明

名称	类型	是否必须	默认值	描述
token	`String`	是	无	接口访问凭据，获取方式请参考获取鉴权token

body参数说明

入参字段定义

名称	类型	是否必须	默认值	描述
crowdId	`String`	是	无	用户群id
taskId	`Long`	是	无	人群导出任务id，获取方式请参考创建用户群导出任务

入参示例

{
  "crowdId": "CROWD_yyyy-MM-dd_XXX",
  "taskId": 1001
}

Response响应说明

出参data字段定义

名称	类型	描述
appId	`String`	应用id
crowdId	`String`	用户群id
taskId	`Long`	任务id
uidType	`String`	导出ID类型
status	`Byte`	任务状态,0:执行中、1：成功、2：失败
fileIdList	`List<String>`	文件Id列表，任务状态为成功时返回。使用fileId导出用户群单个文件

http code: 200(http code码说明)
正常响应出参示例

{
  "data": {
    "appId": "appId1",                // 应用id
    "crowdId": "CROWD_yyyy-MM-dd_XXX",                // 用户群id
    "taskId": 1001,                // 任务id
    "uidType": "GTCID",                // 导出ID类型
    "status": 1,                // 任务状态,0:执行中、1：成功、2：失败
    "fileIdList": [                // 文件Id列表，任务状态为成功时返回
      "9e385078-8210-4ebc-a4fe-e8edde2476eb",
      "9e385078-8210-4ebc-a4fe-e8edde2476ec"
    ]
  },
  "code": "0",                // 响应code码
  "msg": "成功"                // 响应信息
}

请求示例

curl $BaseUrl/export/crowd/exportCrowdTaskStatus\
-X POST \
-H "Content-Type: application/json;charset=utf-8" \
-H "token: $token" \
-d '{
    "crowdId": "CROWD_yyyy-MM-dd_XXX",
    "taskId": 1001
}'

【用户导出】查询用户群导出任务单个文件数据

开发者可以通过该接口获取到导出任务状态为成功单个fileId对应的数据，开发者可通过任务状态查询接口返回的fileId列表，多次请求该接口获取到导出任务的完整数据。注意：必须是导出状态为成功的任务，才能调用该接口正常返回数据。
说明：该功能为 VIP 功能，若须使用请点击右侧“技术咨询”了解详情。

接口定义

接口地址: $BaseUrl/export/crowd/exportCrowdSingleFile
请求方式: POST
content-type:application/json;charset=utf-8

Request请求说明

Header参数说明

名称	类型	是否必须	默认值	描述
token	`String`	是	无	接口访问凭据，获取方式请参考获取鉴权token

body参数说明

入参字段定义

名称	类型	是否必须	默认值	描述
crowdId	`String`	是	无	用户群id
taskId	`Long`	是	无	任务id
fileId	`String`	是	无	导出文件id,通过查询用户群导出任务状态接口获取fileId

入参示例

{
  "crowdId": "CROWD_yyyy-MM-dd_XXX",
  "taskId": 1001,
  "fileId": "9e385078-8210-4ebc-a4fe-e8edde2476eb"
}

Response响应说明

出参data字段定义

名称	类型	是否必须	默认值	描述
list	`List<String>`	否	无	id列表，目前最大size=1000000
total	`Long`	否	无	id列表数量

http code: 200(http code码说明)
正常响应出参示例

{
  "data": {
    "list": [                 // id列表
      "gtcid1",
      "gtcid2"
    ],
    "total": 10000000                // id数量
  },
  "code": "0",                 // 响应code码
  "msg": "成功"                // 响应信息
}

请求示例

curl $BaseUrl/export/crowd/exportCrowdSingleFile\
-X POST \
-H "Content-Type: application/json;charset=utf-8" \
-H "token: $token" \
-d '{
    "crowdId": "CROWD_yyyy-MM-dd_XXX",
    "taskId": 1001,
      "fileId": "9e385078-8210-4ebc-a4fe-e8edde2476eb"
}'

以上文档对您是否有帮助？

当前位置：用户运营 > 服务端 > RestAPI > 用户API

用户 API

用户 API

简述

【用户导入】事件埋点数据导入

接口定义

Request请求说明

Response响应说明

请求示例

【用户导入】用户埋点数据导入

接口定义

Request请求说明

Response响应说明

请求示例

【用户导出】用户群列表查询

接口定义

Request请求说明

Response响应说明

请求示例

【用户导出】创建用户群导出任务

接口定义

Request请求说明

Response响应说明

请求示例

【用户导出】查询用户群导出任务状态

接口定义

Request请求说明

Response响应说明

请求示例

【用户导出】查询用户群导出任务单个文件数据

接口定义

Request请求说明

Response响应说明

请求示例

文档中心搜索