创建用户列表的查询id--增长分析 DataFinder-火山引擎

文档中心

立即注册

导航

增长分析 DataFinder

创建用户列表的查询id

最近更新时间：2024.06.30 18:36:03首次发布时间：2024.06.30 18:36:03

请求说明

Path：/openapi/v1/{app_id}/user_analysis/queries
Method: POST
Content-type: application/json

请求参数

Body:

参数	类型	是否必选	示例值	描述
profile_names	list	否	null	需要查询的用户属性名列表传null时，会自动查询20个用户属性传[]时，不会查询任何用户属性如果只关心用户id，强烈建议传[]以加快查询速度
id_types	list	否		需要查询的id类型，按照逗号（,）进行分割
query_type	str	是		用户列表的查询类型，包括： analysis，显微镜功能 cohort，分群功能
analysis	object	query_type为analysis时必须		当query_type为analysis时，该字段需要传dsl
cohort	object	query_type为cohort时必须		当query_type为cohort时，该字段需要传分群id
limit	int	否		查询数量，暂时强制为1000无法修改

返回参数

Response:

{
    "code": 200,
    "message": "success",
    "data": {
        "query_id": "za9fa417b308a1c8e01"
    }
}

Field	Type	Description
query_id	str	用户列表的查询id

请求示例

bc 为创建的 RangersClient, 其初始化请参考使用说明，各语言的 SDK 都提供了类似的接口
调用(Python)：：

body={
    "analysis": {
        "dsl": {省略}
    },
    "limit": 1000,
    "profile_names": [],
    "query_type": "analysis"
}
res = bc.data_finder('/openapi/v1/12345/user_analysis/queries', body=body)
print(res.content)

返回示例

返回结果：

{
    "code": 200,
    "message": "success",
    "data": {
        "query_id": "za9fa417b308a1c8e01"
    }
}

5.3 创建analysis类型的用户列表查询id

从各种高级分析的显微镜创建的用户列表查询id为analysis类型。analysis中的dsl可以从前端获取，如下图：

5.4 创建cohort类型的用户列表查询id

从分群创建的用户列表id为cohort类型。cohort类型时，body参数可以如下填写：

{
    "cohort": {
        "cohort_id": <cohort_id: int>
    },
    "query_type": "cohort"
}