Usage Intelligence Reporting API (3.0.0)
The Usage Intelligence Reporting API is targeted for advanced users who would like to build their own dashboards or integrate Usage Intelligence reporting (charts or raw data) within third party applications. The API can also be used to export data and statistics out of the Usage Intelligence servers for archiving or custom processing by other solutions.
NOTE: For information on global filters and segmentation in API reporting, see Global Filters and Segmentation and Levels (Date-Range Reports).
For Developer: To access our APIs programmatically, begin by obtaining the CSRF cookie. Send a GET request to the /v3/request-csrf endpoint with the appropriate headers, as specified in the auth API. Upon success, you'll receive a 204 status code. Then, utilize this obtained cookie when while using the auth API. After successful authentication, you'll receive two cookies: RUI-Csrf and RUI-Session-Token. Keep these cookies for subsequent requests. If authentication fails, expect to receive a 401 error code.
NOTE: The value for Origin should be https://analytics.revenera.com for all API endpoints. Providing a different value will result in an error.
To help you get hands-on experience with our APIs, we have provided a Postman collection for download. This collection will allow you to seamlessly test and explore the API endpoints in a familiar environment.
How to explore APIs using Postman:
- Download the Postman Collection: Download
- Import into Postman: Open your Postman app and import the collection.
- Authenticate: Replace the "username" and "password" placeholders with your credentials (the same ones used in the Usage Intelligence Dashboard at https://analytics.revenera.com) in the /auth/web API endpoint body, then click Send.
- Personalize: Replace the demo "product_id" in the API endpoints with your own "product_id" and modify the sample payload as per your product’s requirements.
Start exploring the APIs!