Reporting API

The Reporting API offers a multitude of opportunities for users to access and analyze a range of valuable information. These reports provide insight into various topics to assist in decision-making and actions. Discover how to utilize this tool effectively to generate reports that offer valuable insights and access necessary information. Allow the Reporting API to serve as a valuable resource as you work towards a more informed and impactful future.

Standard Flow of Operations

In order to pull a report, you will want to:

1. Generate a Security Token,

2. Optionally Pull the Report List

3. Pull a Report.

Security

One of your first steps will be to create a security token. A security token can be passed to and from the server in subsequent calls to verify the identity of the call. The security tokens expire in 72 hours. The expiration time is configurable at the create token call. You can also encode parameter information into the token. This information encoded in a token will always override any information passed in via other methods. An example of where this will be useful is if you want to create a token that can only run one report, and only for one merchant, but the parameters for the date range is not locked to the token, allowing the end consumer to who you pass the token to choose their own date ranges.

Report Definitions

Using your token, you can get a definition of the reports you can call. These reports have query security in their configuration, you will only be able to get details on reports you have access to. You can also only run reports that you have access to.