Skip to main content
The Explorer API provides an API-friendly way to run queries programmatically and retrieve data from the Allium App in bulk. Execute saved queries on demand, schedule automated data pulls, and retrieve results in a structured format—all via REST endpoints.

​
Creating Queries

You have two options for creating queries:
  1. Via the Allium App - Create and save queries through the UI (Learn more)
  2. Via the API - Create queries programmatically using the Create Query endpoint
Both methods generate a query ID that you’ll use in subsequent API requests.

​
Programmatic Workflow

For production use, run a query yourself and track the run_id it returns rather than reading the latest scheduled run. See Programmatic query workflow for the run → poll → fetch pattern.

​
Available Endpoints

​
Query Management

Create Query

Create a new saved query programmatically

Update Query

Modify an existing saved query

Execute Query

Create a new query run for a saved query

​
Query Run Management

Get Latest Run

Retrieve the latest query run information

Check Run Status

Retrieve the status of a query run

Get Results

Retrieve the results of a query run

Cancel Run

Cancel a running query