Introduction to the Reporting API

NOTE:
Reporting API needs to be activated before use. Please contact your Evotix representative if interested to learn more.

Prerequisites

Supported Database:
The Reporting API will only work with MS-SQL databases, Versions 2012 R2 and above.

Authentication:
The Reporting API supports Basic Auth and API key-based authentication.

To use API Key authentication, users can generate API keys within the web application by navigating to Designer Security API Keys.

Create a new API key for the user who will call the Reporting API. Make sure to save the API Key before clicking save button.

The Reporting API will allow clients to consume data from the Data Warehouse. The APIs will support the OData protocol, so it can be consumed by applications that support this protocol.

Using a subset of the OData protocol (https://www.OData.org) will allow clients to query and access data in their Data Warehouse.

The level of interaction with the Reporting API will depend on the tool consuming this data, as different tools have varying capabilities and approaches to the use of OData.

The Reporting API will support our dynamic data structure so any changes to fields and relationships will be available via the API after a successful publish and ETL run.