1

Create an API Key

Go to your Workspace settings and create an API Key, it will be necessary to use all Data API endpoints.

2

Initialize Explorer Application

The Data API endpoints are executed on your cloud provider, ensuring your data is always secure.

In order to do that, you need to initialize an application that will process the queries and wait until it is fully active.

This process usually takes around 2 minutes.

3

Create your query

Nekt Data API is powered by Spark SQL and runs every query that you can also run on the Explore module.

The most common use case is to query the data of a specific table:

query.sql
SELECT
    *
FROM
    "nekt_raw"."table_name"
LIMIT
    200

But you can also use SQL filters, joins, where clauses and many more SQL statements.

4

Submit query execution

After defining the query, you will submit it for execution.
The API will process 100 records at a time, so you need to specify which page_number this execution will process.

5

Process results

When the execution of a specified page is finished, you can use the API to obtain a presigned URL that gives you access to a Parquet file containing the results.

The presigned url is only valid for 1 hour.

6

Repeat steps 4 & 5, if needed

If your query has more than 100 results, you most likely will want to get the next results.
In order to do that, submit a new query execution (Step 4), increasing the page_number by 1.

Pseudo code implementation