POST
/
api
/
v1
/
explorer
/
queries
/
{query_id}
/
run-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": 123
  }
}'
"<any>"

​
Execute Query Async

​
Request fields

Field nameDescription
parametersKey-value map of parameter names and their respective values.
run_configQuery run configuration to use when creating the query run.
run_config.limitThe query row limit to use for this query run.

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

​
Example

curl -X 'POST' \
  'https://api.allium.so/api/v1/explorer/queries/{query_id}/run-async' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: <YOUR API KEY>' \
  -d '{
  "parameters": {},
  "run_config": {
    "limit": 1000,
  }
}'

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
query_id
string
required

Body

application/json
​
parameters
object
required
​
run_config
object

Response

200
application/json
Successful Response

The response is of type any.