Skip to main content
POST
/
api
/
v1
/
explorer
/
queries
/
{query_id}
/
run-async
Execute Query Async
curl --request POST \
  --url https://api.allium.so/api/v1/explorer/queries/{query_id}/run-async \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "parameters": {},
  "run_config": {
    "limit": 1000,
    "compute_profile": "<string>"
  }
}'
{
  "run_id": "<string>"
}
Trigger execution of an Explorer query. You will need to have a query created through the web UI before calling this endpoint.
  • If you are running a parameterized query, use parameters to specify parameter values.
  • You can optionally specify a row limit, and a compute profile to run the query on.
Limit: We currently allow up to 250,000 rows of data (that can be increased on request) to be exported through the API for a single query. This limit is put in to prevent mishaps from happening when users forget to put LIMIT at the end of their queries. After creating a new query run, you likely want to poll for its status, and retrieve the results when it has completed.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
query_id
string
required

Body

application/json
​
parameters
object
required

Parameter names and values, to be substituted into parameter placeholders in the saved query

​
run_config
object

Response

Successful Response

​
run_id
string
required
⌘I