API Documentation

API Quickstart

Authentication

API uses token-based authentication via HTTP header. Each request must contain an X-Auth-Token header with JSON Web Token (JWT) value. Tokens can be obtained from the User Access Management page.

Tokens can be issued per user or per site. User tokens contain permissions assigned to the specific user, and are time-limited. It is possible to renew the token prior to expiration. Site tokens are not time-limited and contain all permissions for the site.

Using the API

List of APIs and specific documentation for each is available at your site url https://<your-app-url>/api, for example https://next.forecastingapp.com/api. You should always consult your site-specific API documentation.

It is not recommended to use APIs flagged as deprecated or internal, as they may change or be removed without notice.

Use Cases

Programmatically Accessing Data Snapshots

v1/reports

When you need some data that is preprocessed or aggregated you can use reports API to execute preconfigured snapshots. This is particularly useful when you need to integrate some data slice in third-party tools such as spreadsheets.

Steps:

1. Use report designer to build a report in desired format

2. Save the report and note its ID

3. Use the ID to execute the report and retrieve data

Alternatively you can export the ready-made report from the designer in JSON format, and send this as part of the payload to the API. This approach enables you to programmatically adjust parameters such as dates or filters per each request. 

Excel and External Tool Access

To make it easy to use data directly in spreadsheets or other tools, reports can be accessed through shareable URLs that include your authentication token.

How it works

1. Log in to your Automat application.

2. Navigate to the desired report and click “Share via URL.”

3. This will create a link that already contains your current authentication token.

4. Paste the link into Excel, Google Sheets, or another tool that supports importing data from URLs.

Example:

=IMPORTDATA("https://next.forecastingapp.com/api/v1/exports/export-report/<report-id>?token=<jwt-token>&format=csv")

or, using curl:

curl -X 'GET' \

  'https://next.forecastingapp.com/api/v1/exports/export-report/<report-id>?token=<jwt-token>&format=html' \

  -H 'accept: application/json'

Token behavior

1. The same JWT token is used as in header-based authentication — only the delivery method differs.

2. The token remains valid according to your user or site configuration.

3. Tokens can be renewed before expiry from the User Access Management page.

Recommended usage

1. For recurring Excel imports, consider using a dedicated integration user with limited permissions.

2. If sharing files externally, generate a short-lived (“day pass”) token to minimize exposure.

3. Always keep links private — URLs containing tokens grant the same access as your authenticated session.

Manipulating Data in Bulk

v1/data

Automat Pipeline tool is designed to handle massive workloads. It can be used to build an ingestion/extraction pipeline, and read/write from/to cloud storage such as S3, or third-party APIs.

You can use the demo playground without installing anything.

https://targetta.github.io/ankaflow/demo/

Playground notes:

• The playground is limited to public APIs and has no persistent storage.

• You can connect your own bucket, but ensure CORS is properly configured for browser access.