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": {}
}
'
import requests

url = "https://api.allium.so/api/v1/explorer/queries/{query_id}/run-async"

payload = {
"parameters": {},
"run_config": {}
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({parameters: {}, run_config: {}})
};

fetch('https://api.allium.so/api/v1/explorer/queries/{query_id}/run-async', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.allium.so/api/v1/explorer/queries/{query_id}/run-async",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'parameters' => [

],
'run_config' => [

]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.allium.so/api/v1/explorer/queries/{query_id}/run-async"

payload := strings.NewReader("{\n \"parameters\": {},\n \"run_config\": {}\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.allium.so/api/v1/explorer/queries/{query_id}/run-async")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"parameters\": {},\n \"run_config\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.allium.so/api/v1/explorer/queries/{query_id}/run-async")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"parameters\": {},\n \"run_config\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "run_id": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}
Trigger execution of a saved Explorer query. You will need to create a query through the Allium App before calling this endpoint.

Key Parameters

  • Parameterized queries - Use the parameters field to specify parameter values when running a parameterized query
  • Row limit - Optionally specify a maximum number of rows to return
  • Compute profile - Optionally specify a compute profile to run the query on

Data Export Limit

Maximum Rows: 250,000We currently allow up to 250,000 rows of data to be exported through the API for a single query. This limit can be increased on request and helps prevent mishaps when users forget to add LIMIT clauses to their queries.

Next Steps

After creating a new query run:
  1. Poll for its status to check if the query has completed
  2. Retrieve the results when execution is finished

Authorizations

X-API-KEY
string
header
required

Path Parameters

query_id
string
required

Body

application/json
parameters
Parameters · object
required

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

run_config
Run Config · object

Response

Successful Response

run_id
string
required