用户属性搜索查询
接口URL
/api/open_api/v1/user/search?token=xxx
请求方式
POST
Content-Type
application/json
请求Query参数
|
参数名
|
参数类型
|
是否必填
|
参数描述
|
|
token
|
String
|
是
|
查询token
|
请求Body参数
用户属性搜索集成在页面的右上角，如下图所示，点击用户搜素即进行搜索页面，如下图所示， 请求参数由搜索属性参数（properties）、筛选参数（filter）、是否查看完整用户列表（searchAll）、时区参数（timeZoneOffset）组成。其中筛选参数和时区参数为通用参数，可见通用参数列表。
参数说明
|
参数名
|
参数类型
|
是否必填
|
说明
|
|
properties
|
List[Object]
|
否
|
需要获取的用户属性，仅当searchAll为true时生效
|
|
coulmn_name
|
String
|
否
|
属性名
|
|
filter
|
Object
|
是
|
通用参数，参见"如何表示一个筛选项"
注：用户属性搜索查询仅支持通过用户属性查询，且不支持使用用户标签及分群进行查询。即在用户属性搜索查询接口中仅支持使用用户属性，不支持事件属性及tagVersion、tagHistoryDate、cohort_name参数
|
|
searchAll
|
Boolean
|
是
|
是否查看完整的用户列表
是：true
否：false
|
|
timeZoneOffset
|
Number
|
否
|
通用参数，表示计算时区，如8、-8，若未传递，则默认表示0时区
|
基于上述说明，设定场景：查询DT-ID为.....的用户。
给予参数示例如下：
{
"properties": [],
"filter": {
"comparator": "C00",
"filterValue": [
...
],
"display_name": "DT-ID",
"describe": "DT 系统的设备唯一 ID；用户在未登录状态下的唯一标识，应用卸载重新安装后，该 ID 不会变化",
"type": 1,
"table_type": "user",
"extra": {
"original_column_type": "varchar",
"parent_column_type": null
},
"name": "#dt_id",
"data_type": "string",
"columnName": "#dt_id",
"columnType": "string",
"columnDesc": "DT-ID",
"tableType": "user"
},
"timeZoneOffset": 2,
"searchAll": false
}请求响应结果
|
参数名
|
参数类型
|
参数描述
|
|
columnMeta
|
Object
|
data_list里中展示的字段解析，当传递searchAll为fasle时默认返回$uid
|
|
data_list
|
List[Object]
|
用户列表详情，对象中为属性名：属性值的键值对，当searchAll为false时返回的列表长度默认为10，当searchAll为true时列表长度为计算的结果数
|
| total | Number | 总数，最多返回1000条 |
示例
以下图所示的分析场景，进行API查询。
那么最终返回结果如下示例：
{
"columnMeta": {
"#acid": "账号 ID",
...
},
"data_list": [
{
"#acid": "-",
"#active_device_brand": "-",
"#active_device_model": "Destini",
"#active_os": "Android",
"#dt_id": "GEheYwZasLEEHtDqajNVMtRTMFNGHwgH",
"$active_event_syn": "d3a2497fdcad466dad23899b68dfb423",
"$cac": "2.00000000",
"$uid": "1867161062240026624"
},
...
],
"total": 100
}