Understanding the Report Lifecycle#
Once a report is published, it is displayed on the merchant dashboard and an API call is made to your servers ( Your Data source ) to fetch the data and render it. This entire rendering is carried out in the Browser and does not involve back-end server-to-server calls.Authentication Mechanism#
All the requests made to your data source from the merchant dashboard use a rolling bearer token attached in the Authorization header.Validating Authentication Token#
To validate an in-coming request, your data source must make an API request to validate the token and retrieve account specific information related to the App and the Merchant.Data Mapping via JMESPath & API Responses#
Your API responses do not need to enforce a certain schema, the report Creator tool allows you to write powerful JMESPath expressions that can easily map your response schema to the schema required for each visualization.However, you must adhere to the following minimum requirements:API must return a valid JSON response.
API must implement standard HTTP status codes.
Avoid more than 3 levels of nested trees when running JMESpath expressions.
API round-trip excluding token verification may not be more than 2 seconds.
Modified at 2026-03-03 13:30:31
