# 生成SQL语句 API
调用方法请参见Open API文档中的调用方法描述。
# 生成查询用户的SQL语句
接口URL
/open/get-sql-for-user-search?token=xxx&projectId=377
请求方式
POST
Content-Type
application/json
请求Query参数
参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
token | xxx | String | 是 | token |
projectId | 0 | Integer | 是 | 项目ID |
请求Body参数
{
"filter": {
"filterType": "COMPOUND",
"relation": "and",
"filts": [
{
"filterType": "SIMPLE",
"tableType": "user",
"columnName": "city",
"comparator": "equal",
"ftv": [
"上海市"
]
},
{
"filterType": "SIMPLE",
"tableType": "user",
"columnName": "companynature",
"comparator": "equal",
"ftv": [
"民营"
]
}
]
},
"selectAllColumns": false,
"selectColumns": [
"#account_id", "#distinct_id"
]
}
参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
selectAllColumns | false | Boolean | 否 | 是否查询所有字段,默认false |
selectColumns | ["#account_id", "#distinct_id"] | List | 否 | 查询字段名称列表 |
filter | - | List | 是 | 属性筛选器 |
∟ filterType | COMPOUND | String | 否 | 筛选器 COMPOUND:复合类型 SIMPLE:简单类型 |
∟ relation | and | String | 否 | 筛选逻辑关系 |
∟ filts | - | Object | 否 | 筛选对象列表 |
∟ filterType | SIMPLE | String | 否 | 筛选器 COMPOUND:复合类型 SIMPLE:简单类型 |
∟ tableType | user | String | 否 | event:事件属性,user:用户属性 |
∟ columnName | city | String | 是 | 字段名称 |
∟ comparator | equal | String | 否 | 比较操作符 |
∟ ftv | ["民营"] | List | 否 | 筛选值列表 |
成功响应示例
{
"data": {
"sql": "select \"#user_id\", \"#account_id\", \"#distinct_id\" from (v_user_377) where (\"city\" IN ('上海市')) and (\"companynature\" IN ('民营'))"
},
"return_code": 0,
"return_message": "success"
}
参数名 | 示例值 | 参数类型 | 参数描述 | |
---|---|---|---|---|
data | - | Object | 返回结果 | |
∟ sql | "select \"#user_id\", \"#account_id\", \"#distinct_id\" from (v_user_377) where (\"city\" IN ('上海市')) and (\"companynature\" IN ('民营'))" | String | SQL语句 | |
return_code | 0 | Integer | 返回码 | |
return_message | success | String | 返回信息 |
错误响应示例
{
"return_code": -1008,
"return_message": "报错描述"
}
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
return_code | -1008 | Integer | 返回码 |
return_message | 报错描述 | String | 返回信息 |