Key Parameters
- title - A descriptive name for your query
- config.sql - The SQL query to execute
- config.limit - Maximum number of rows to return (default: 1000)
- config.parameters - Optional parameter definitions for templated queries using
{{parameter_name}}syntax - config.compute_profile - Optional compute profile identifier for query execution
Query Response
The endpoint returns aquery_id that you can use to:
- Run the query
- Update the query
- Reference in your application
Example: Creating a Parameterized Query
Data Export Limit
Maximum Rows: 250,000Queries created through the API follow the same export limits as queries created in the Allium App. The maximum number of rows that can be exported is 250,000. This limit can be increased on request.
Next Steps
After creating a query:- Save the returned
query_idfor future reference - Execute the query to get results
- Update the query if you need to modify it later