Post Query

Processes queries using either a query string or a query template. The query_string field holds direct queries or templates that can be modified with specified parameters. You can also reference saved query templates by their template_id or template_name. These templates, regardless of how they’re called, can be used with or without parameters. If the query produces results, the results are stored in a table. If the table_name and schema are provided, a table is created and the results are stored in that table. Overriding an existing table is also possible if specified. If no table_name or schema is provided, the table is stored in the ‘qm’ schema with a randomly generated name. The endpoint returns a QueryLog as a response.

Request

Request Body

query_string: Optional[str] template_id: Optional[int] template_name: Optional[str] parameters: Optional[dict]

Request Parameters

schema: str, default: “qm” The schema to retrieve the tables from. If no parameter is provided, defaults to “qm”. table_name: str, default: random generated name the name that will be used to create the table overwrite: bool, default: False determines if the table shall be overwritten or not max_results: int, default: 0 specifies the maximum number of records that should be returned in the result set (max: 100)

Response

QueryLogResponse

query_id: str A unique ID that identifies the query. statement_type: str The query type (ex. SELECT, BUILD, etc.). start_time: datetime The start time of the query execution. end_time: datetime The end time of the query execution. query: str The query string that was executed. referer: str Indicates where the REST API call was made from. state: str Shows the state of the query execution (Either RUNNING or COMPLETE). destination_table_name: str Shows table where the results are stored in (If the statement_type is a SELECT, a new destination_table is created. Otherwise, the destination_table_name shows the affected table). destination_schema: str Shows in which schema the destination_table is stored in. error_result: str Stores the error message if there was an error executing the query. created_at: datetime Shows the timestamp of when the query log was created. records: dict list Returns a sample of the data (max. 100)