Explorer API User Tutorial

1. Introduction

Go to https://app.allium.so/explorer/api

2. Generate API keys and run asynchronously

Allium Explorer exposes the following endpoints through a REST API to fetch and poll your query run.

1. POST /api/v1/explorer/queries/{query_id}/run-async: Execute the query asynchronously. This creates a query run ID for you to poll the status and results from

2. GET /api/v1/explorer/query-runs/{run_id}/status: Get the status of a query run as an enumeration of created | queued | running | success | failed | canceled

3. GET /api/v1/explorer/query-runs/{run_id}/results: Get the results of a query run with status success.

The typical flow would be to

1. Create a query run, and get the run_id

2. Poll the query run status using the run_id in a while loop

3. When the query run status is success, get the results

If any questions remain after this guide on how to get started, connect to our APIs, or retrieve specific data you have in mind, feel free to reach out to [e-mail] at any time.