SQL statement generation API

Last updated 10/03/2026

For how to call the API, see the calling method described in the Open API document.

1. Generate an SQL statement for querying users

Endpoint URL

/open/get-sql-for-user-search?token=xxx&projectId=377

Request method

POST

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	0	Integer	Yes	Project ID

Request body parameters

{
  "filter": {
      "filterType": "COMPOUND",
      "relation": "and",
      "filts": [
        {
          "filterType": "SIMPLE",
          "tableType": "user",
          "columnName": "city",
          "comparator": "equal",
          "ftv": [
            "Shanghai"
          ]
        },
        {
          "filterType": "SIMPLE",
          "tableType": "user",
          "columnName": "companynature",
          "comparator": "equal",
          "ftv": [
            "Private"
          ]
        }
      ]
  },
  "selectAllColumns": false,
  "selectColumns": [
     "#account_id", "#distinct_id"
  ]
}

Parameter name	Example value	Parameter type	Required	Description
selectAllColumns	false	Boolean	No	Whether to query all fields. Defaults to false
selectColumns	["#account_id", "#distinct_id"]	List	No	List of field names to query
filter	-	Object	Yes	Property filter
filter.filterType	COMPOUND	String	No	Filter COMPOUND: compound type SIMPLE: simple type
filter.relation	and	String	No	Logical relationship of the filter
filter.filts	-	List	No	List of filter objects
filter.filts.filterType	SIMPLE	String	No	Filter COMPOUND: compound type SIMPLE: simple type
filter.filts.tableType	user	String	No	user: user property
filter.filts.columnName	city	String	Yes	Field name
filter.filts.comparator	equal	String	No	Comparison operator
filter.filts.ftv	["Private"]	List	No	List of filter values

Success response example

{
  "data": {
    "sql": "select \"#user_id\", \"#account_id\", \"#distinct_id\" from (v_user_377) where (\"city\" IN ('Shanghai')) and (\"companynature\" IN ('Private'))"
  },
  "return_code": 0,
  "return_message": "success"
}

Parameter name	Example value	Parameter type	Description
data	-	Object	Returned result
data.sql	"select \"#user_id\", \"#account_id\", \"#distinct_id\" from (v_user_377) where (\"city\" IN ('Shanghai')) and (\"companynature\" IN ('Private'))"	String	SQL statement
return_code	0	Integer	Return code
return_message	success	String	Return message

Error response example

{
    "return_code": -1008,
    "return_message": "Error description"
}

Parameter name	Example value	Parameter type	Description
return_code	-1008	Integer	Return code
return_message	Error description	String	Return message