查询用户的行为和明细数据 - GetUserDetailAndEvent--客户数据平台-火山引擎

文档中心

导航

查询用户的行为和明细数据 - GetUserDetailAndEvent

最近更新时间：2024.12.06 13:08:26首次发布时间：2024.07.12 14:50:50

请求说明

请求方式：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	项目ID
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": "576465150349934594",
        "id_type": "baseid",
        "event": [
            {
                "datasource_id": 37,
                "event_ids": [
                    11
                ],
                "start_time": "1732609482",    // 时间戳
                "end_time": "1733214282",
                "need_properties": false
            }
        ]
    }
}

返回示例

{
    "code": 0,
    "illegalInput": [
        "event_37_11"
    ],
    "data": {
        "event": [],
        "detail": []
    },
    "message": ""
}

错误码

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

HTTP 状态码	错误码	错误信息	说明
400	invalidParameter	PARAMETER INVALID	参数非法，检查入参。

客户数据平台