Skip to content

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.

Explore the APIs Using Postman

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:

  1. Download the Postman Collection: Download
  2. Import into Postman: Open your Postman app and import the collection.
  3. 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.
  4. 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!

Download OpenAPI description
v3_api_redocly.json
v3_api_redocly.yaml
Languages
Servers
Mock server
https://rui-api.redocly.app/_mock/v3_api_redocly
https://analytics-api.revenera.com

Auth

Operations

Metadata Queries

Operations

Event Tracking Management

Operations

Generic Reports

Operations

User Engagement Histogram

Operations

Event Tracking Reports

Operations

License Key Registry Management

Operations

Custom Event Tracking

Operations

Exception Tracking

Operations

Latest Data Preview

Request

This Latest Data Preview request returns the last few exceptions that have been collected including the product and system metadata of the client on which each exception was collected in JSON format.

Path
product_idstringrequired
Headers
Content-Typestring
Example: application/json
RUI-Clientstring
Example: Postman
RUI-Client-Versionstring
Example: 0.0.1
Originstring
Example: https://analytics.revenera.com
Bodyapplication/json
object
curl -i -X POST \
  'https://rui-api.redocly.app/_mock/v3_api_redocly/v3/exceptionTracking/getLastLines/{product_id}' \
  -H 'Content-Type: application/json' \
  -H 'Origin: https://analytics.revenera.com' \
  -H 'RUI-Client: Postman' \
  -H 'RUI-Client-Version: 0.0.1' \
  -d '{
    "lineCount": 2
  }'

Responses

OK

Headers
Serverstring
Example: "nginx/1.20.1"
Datestring
Example: "Thu, 13 Jul 2023 11:19:00 GMT"
Content-Typestring
Example: "application/json"
Content-Lengthinteger
Example: "3142"
Connectionstring
Example: "keep-alive"
Access-Control-Allow-Originstring
Example: "https://analytics.revenera.com"
Access-Control-Allow-Credentialsboolean
Example: "true"
Varystring
Example: "Origin"
Rui-Apistring
Example: "RUI Reporting API (3.0.0.dev9)"
Rui-Libstring
Example: "3.0.0.dev26"
X-XSS-Protectionstring
Example: "1; mode=block"
X-Content-Type-Optionsstring
Example: "nosniff"
Referrer-Policystring
Example: "no-referrer-when-downgrade"
Bodyapplication/json
object
Response
application/json
{
  "fieldNames": {
    "timestamp": "Timestamp",
    "clientId": "Client ID",
    "prodEdition": "Edition",
    "prodVersion": "Version",
    "prodBuild": "Build",
    "prodLanguage": "Language",
    "licenseType": "License Type",
    "licenseStatus.allowed": "Key Allowed",
    "licenseStatus.blocked": "Key Blocked",
    "licenseStatus.activated": "Key Activated",
    "licenseStatus.expired": "Key Expired",
    "os.version": "OS Type",
    "osWordLength": "OS Architecture",
    "osLanguage": "OS Language",
    "windowsFullBuild": "Windows Full Build",
    "cpuType": "CPU Type",
    "cpuCores": "CPU Cores",
    "ram": "RAM",
    "displayCount": "Number of Monitors",
    "resolution": "Screen Resolution",
    "dotNetVersion": ".NET Versions",
    "gpu.model": "GPU",
    "formFactor": "Computer Type",
    "javaVmVersion": "Java VM Version",
    "javaVersion": "Java Version",
    "javaVmName": "Java VM Name",
    "javaVendor": "Java Vendor",
    "Java Runtime Version": "Java Runtime Version",
    "Java AWT Graphics Environment": "Java AWT Graphics Environment",
    "javaVmRam": "Java VM RAM",
    "vm": "Virtual Machine",
    "geography.country": "Country",
    "geography.usState": "US State",
    "exception.class": "Exception Class",
    "exception.method": "Exception Method",
    "exception.message": "Exception Message",
    "exception.stackTrace": "Exception Stack Trace"
  },
  "result": [
    { … },
    { … }
  ]
}

List Files Exceptions

Request

This List Files Exceptions request returns the list of zipped CSV files that are on the server. This list is to be used to see what files are available for download and then be able to request files for downloading.

Path
product_idstringrequired
Headers
Content-Typestring
Example: application/json
RUI-Clientstring
Example: Postman
RUI-Client-Versionstring
Example: 0.0.1
Originstring
Example: https://analytics.revenera.com
curl -i -X GET \
  'https://rui-api.redocly.app/_mock/v3_api_redocly/v3/exceptionTracking/listFiles/{product_id}' \
  -H 'Content-Type: application/json' \
  -H 'Origin: https://analytics.revenera.com' \
  -H 'RUI-Client: Postman' \
  -H 'RUI-Client-Version: 0.0.1'

Responses

OK

Headers
Serverstring
Example: "nginx/1.20.1"
Datestring
Example: "Thu, 13 Jul 2023 11:20:16 GMT"
Content-Typestring
Example: "application/json"
Content-Lengthinteger
Example: "314"
Connectionstring
Example: "keep-alive"
Access-Control-Allow-Originstring
Example: "https://analytics.revenera.com"
Access-Control-Allow-Credentialsboolean
Example: "true"
Varystring
Example: "Origin"
Rui-Apistring
Example: "RUI Reporting API (3.0.0.dev9)"
Rui-Libstring
Example: "3.0.0.dev26"
X-XSS-Protectionstring
Example: "1; mode=block"
X-Content-Type-Optionsstring
Example: "nosniff"
Referrer-Policystring
Example: "no-referrer-when-downgrade"
Bodyapplication/json
object
Response
application/json
{
  "openDailyFiles": [],
  "dailyFiles": [
    { … },
    { … }
  ],
  "monthlyFiles": []
}

Download Zipped CSV

Request

In order to download the exception tracking data files, the file needs to be requested to the API which returns a secure URL from which the file can be downloaded. The request and response are both JSON objects.

Path
product_idstringrequired
Headers
Content-Typestring
Example: application/json
RUI-Clientstring
Example: Postman
RUI-Client-Versionstring
Example: 0.0.1
Originstring
Example: https://analytics.revenera.com
Bodyapplication/json
object
curl -i -X POST \
  'https://rui-api.redocly.app/_mock/v3_api_redocly/v3/exceptionTracking/getDownloadUrl/{product_id}' \
  -H 'Content-Type: application/json' \
  -H 'Origin: https://analytics.revenera.com' \
  -H 'RUI-Client: Postman' \
  -H 'RUI-Client-Version: 0.0.1' \
  -d '{
    "fileName": "2376158762_exc_2023-07-11.zip"
  }'

Responses

OK

Headers
Serverstring
Example: "nginx/1.20.1"
Datestring
Example: "Thu, 13 Jul 2023 11:19:00 GMT"
Content-Typestring
Example: "application/json"
Content-Lengthinteger
Example: "3142"
Connectionstring
Example: "keep-alive"
Access-Control-Allow-Originstring
Example: "https://analytics.revenera.com"
Access-Control-Allow-Credentialsboolean
Example: "true"
Varystring
Example: "Origin"
Rui-Apistring
Example: "RUI Reporting API (3.0.0.dev9)"
Rui-Libstring
Example: "3.0.0.dev26"
X-XSS-Protectionstring
Example: "1; mode=block"
X-Content-Type-Optionsstring
Example: "nosniff"
Referrer-Policystring
Example: "no-referrer-when-downgrad"
Bodyapplication/json
object
Response
application/json
{
  "downloadUrl": "https://shd1.revenera.com/downloadExc/ribSbEhHSgkmqzRakSSzqkHWeCGxUI"
}

Client Profile Report

Operations

Raw Data Exports

Operations