Introduction
The Reporting API provides a secure way to fetch reporting tables, their schema, and data for integration with external reporting tools (e.g., Power BI, Graph, or any BI tool). The Reporting APIs can be used to identify the DN Table Schema for Reports, identify the Column names and Data types for tables, view the values/data for the respective Table, as well as using a customized query (such as join) to fetch the Table details based on your requirement.
Prerequisites
To login using an API, there are two supported authentication approaches:
JWT Token based authentication
Direct API Key authentication
API Endpoints Overview
Purpose | API Endpoint | Method |
|---|---|---|
| GET | |
| GET | |
| GET | |
| GET | |
| POST |
JWT Token based authentication
In the Reporting API, we have introduced JWT (JSON Web Tokens) based authentication to reduce the risk of security breaches. To authenticate using JWTs, you must enable the following key in web.config. If the key is set as ‘False’ then it authenticates based on the API key & if it is set to 'True' it authenticates using Token based authentication. The JWT configuration setting consists of secret key which cannot be changed and expiry key (in mins) which you can set based on the requirement.
Key: <add key=” JWT: EnableToken” value= “True”/> - Token based Authentication
Key: <add key=” JWT: EnableToken” value= “True”/> - Key based Authentication