Explore the API

The management console allows for live interaction with the API.

To get started, go to The explorer tab. You'll see the various options of the API,
divided to the following sections:

Entity selection.

At the top of the page you can select which entity you'd like to explore.

Group By

In this section you can select the fields you wish to group by.

📘

technical specification

Order By

In this section you can select:

1. The fields you wish to order by.
2. The direction of each field (ascending / descending).
3. The order of the fields.

📘

technical specification

Pagination

In this section you can select which page of the results you wish to see, by specifying the From and Length.

📘

technical specification

Calculate

In this section you can select which calculations you'd like to see

📘

technical specification

Filters

In this section you can specify filters for each of the entity's field.

You can add as many filters as you'd like.

For each filter you need to select the following:

1. The field you wish to filter
2. The operation (e.g. equals, greater than, etc.)
3. The value

Note that different fields support different operations.

📘

technical specification

API Call

In this section you can see how to programmatically recreate the request you configured in different languages.

Results

In this section you can run the API request you configured above using the API key of your choice.

You can then see the results in either a table view (default) or as the raw JSON response.

Additionally, you can export the results to a CSV file and go to different result pages.

If an error occurred, the message will appear instead of the results.

🚧

Running requests counts towards your usage quota.