You need to enable JavaScript to run this app.
导航
GetUserDetailAndEvent - 查询用户的行为和明细数据
最近更新时间:2024.07.25 14:46:10首次发布时间:2024.07.10 15:50:10

请求说明

  • 请求方式:POST
  • 接口名称:GetUserDetailAndEvent
  • 请求地址:https://console.volcengine.com/cdp/open_platform/openapi

请求参数

参数

类型

是否必选

示例值

描述

Authorization

String

HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx

详细介绍请查阅调用方式文档

Query

参数

类型

是否必选

示例值

描述

ApiAction

String

GetUserDetailAndEvent

对应“请求说明”中的“接口名称”

ApiVersion

String

2023-06-20

版本号: 2023-06-20

Body

参数

类型

是否必选

示例值

描述

tenant_code

String

1

租户code

ignore_illegal

Bool

false

默认值是“false”。
含义:是否忽略未导入到在线服务的数据。
"false"代表当入参里面包含未导入的事件id或明细id,会直接报错。
"true":代表仅返回入参中导入到在线服务的事件id或明细id, 并在返回的结果中,将非法的id 放入到“illegal_input”中

data_req

Object

定义如下3.6.1

data_req 字段内容

参数

类型

是否必选

示例值

描述

id

String

1

用户id

id_type

String

uid

用户的id类型,如baseid,uid,deviceid

event

array

[{
  "datasource_id":1,
  "event_ids":[1,2,3],
  "start_time":"1683880304000",//时间戳,单位到毫秒
  "end_time":"1683880305000", //时间戳单位到毫秒
  "need_properties":false  //显示用户的属性值
 }]

行为事件相关的参数,定义3.6.2

detail

array

[{
  "datasource_id":1,
  "columnId":[12,434,54],
  "start_time":"1683880304000",//时间戳,单位到毫秒
  "end_time":"1683880305000"//时间戳,单位到毫秒
 }]

明细相关的参数,定义3.6.3

event 数组元素字段内容

参数

类型

是否必选

示例值

描述

datasource_id

Int

1

数据源id

event_ids

Array[Int]

[1,2,3]

事件ids

start_time

String

1683880304000

起始时间戳,单位 毫秒

end_time

String

1683880305000

截止时间戳,单位 毫秒

need_properties

Bool

false

默认是false,
含义: 是否显示行为上报中用户的属性值

detail 数组元素字段内容

参数

类型

是否必选

示例值

描述

datasource_id

Int

1

数据源id

columnId

Array[Int]

[12,434,54]

明细ids

start_time

String

1683880304000

起始时间戳,单位 毫秒

end_time

String

1683880305000

截止时间戳,单位 毫秒

返回参数

参数

类型

示例值

描述

code

Int

0 代表成功

message

String

data

结构体data

定义如下

illegal_input

Array[str]

data字段内容

参数

类型

示例值

描述

event

Array

定义如下

detail

Array

定义如下

event 数组元素字段内容

参数

类型

示例值

描述

datasource_id

String

1

数据源id

date

String

发生的时间戳,单位到 毫秒

id

String

行为id

name

String

行为名称

properties

String

行为上报时用户的属性值,json 序列化后的String。如果请求参数中need_properties等于false,则此字段为空

detail 数组元素字段内容

参数

类型

示例值

描述

datasource_id

String

1

数据源id

id

String

明细id

name

String

明细名称

value

String

明细具体的值

date

String

发生的时间戳,单位到 毫秒

请求示例

{
"tenant_code":"1",
"ignore_illegal":true, //是否忽略未导入到在线服务的数据
"data_req":{
"id":"1",
"id_type":"uid",
 "event":[{
  "datasource_id":1,
  "event_ids":[1,2,3],
  "start_time":"1683880304000",//时间戳,单位到毫秒
  "end_time":"1683880305000", //时间戳单位到毫秒
  "need_properties":false  //显示用户的属性值
 }],
 "detail":[{
  "datasource_id":1,
  "columnId":[12,434,54],
  "start_time":"1683880304000",//时间戳,单位到毫秒
  "end_time":"1683880305000"//时间戳,单位到毫秒
 }]
}

}

返回示例


错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法,检查入参。