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

Lifetime Events Tracking Histogram

Request

The aim of this report is to show how events occur throughout the clients' lifetime. The data is presented as a histogram showing only a subset of events as specified. The histogram shows how many clients performed an event throughout their lifetime or their average daily/weekly/monthly usage.

This report returns data that is to be represented in chart format. The result consists of histogram-style data for each different event or event combination that has been requested. The results consist of 4 histograms based on different values: event counts, average event count per day, average event count per week, and average event count per month.

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/reporting/eventTracking/lifetime/histogram/{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 '{
    "startDate": "2023-05-15",
    "stopDate": "2023-07-13",
    "groupBy": "clientId",
    "globalFilters": {},
    "events": [
      {
        "combiArray": [
          {
            "category": "Reporting",
            "categoryType": "string",
            "nameType": "string",
            "name": "Show"
          }
        ]
      }
    ]
  }'

Responses

OK

Headers
Serverstring
Example: "nginx/1.20.1"
Datestring
Example: "Thu, 13 Jul 2023 12:17:33 GMT"
Content-Typestring
Example: "application/json"
Content-Lengthinteger
Example: "7792"
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
{
  "summary": {
    "usedAtLeastOnce": [ … ],
    "neverUsed": [ … ]
  },
  "result": {
    "eventCount": [ … ],
    "averageCountPerActiveDay": [ … ],
    "averageCountPerActiveWeek": [ … ],
    "averageCountPerActiveMonth": [ … ]
  }
}

Lifetime Event Tracking Data Table

Request

The aim of this reports is to show how events occur throughout the clients' lifetime. The data is presented as a paged table which shows a list of all events and how many times each occurred.

This report returns data that is to be represented in tabular format. It contains data about each tracked event, how many times it occurred, how many times each user performed each event on average, etc. The events can be presented either as a flat view or categorized hierarchically based on event category and name. Data for each event can then be segmented by any property.

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/reporting/eventTracking/lifetime/dataTable/{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 '{
    "startDate": "2023-05-15",
    "stopDate": "2023-07-13",
    "globalFilters": {},
    "events": null,
    "sorting": {
      "events": "uniqueUsersUsedAtLeastOnce",
      "eventsDirection": "desc",
      "segments": "percentUsedAtLeastOnce",
      "segmentsDirection": "desc"
    },
    "categorizeEvents": true,
    "paging": {
      "startAt": 0,
      "limit": 25
    },
    "groupBy": "clientId",
    "segmentBy": "prodEdition",
    "segments": [
      {
        "type": "regex",
        "value": ".*",
        "split": true,
        "includeNull": true
      }
    ]
  }'

Responses

OK

Headers
Serverstring
Example: "nginx/1.20.1"
Datestring
Example: "Thu, 13 Jul 2023 12:18:38 GMT"
Content-Typestring
Example: "application/json"
Content-Lengthinteger
Example: "6789"
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
{
  "returnedEventsCount": 17,
  "matchingEventsCount": 17,
  "result": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

Event Usage Basic Data Table

Request

This basic event tracking reports is presented in a data table format which is meant to show a list of all known events within a date range and how they occurred. This report contains data about each tracked event, how many times it occurred, how many times each user performed each event on average, etc.

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/reporting/eventTracking/basic/dataTable/{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 '{
    "startDate": "2023-05-15",
    "stopDate": "2023-07-13"
  }'

Responses

OK

Headers
Serverstring
Example: "nginx/1.20.1"
Datestring
Example: "Thu, 13 Jul 2023 12:22:17 GMT"
Content-Typestring
Example: "application/json"
Content-Lengthinteger
Example: "9140"
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
{
  "result": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

Event Usage Basic Timeline

Request

This basic event tracking report is presented in a timeline format which is meant to show the daily usage of a small subset. Normally, the timeline chart is used to drill-down on a selection of events that can be seen on the data table. This report returns a daily/weekly/monthly timeline of how many times each of the requested events occurred. The event occurrence counts can optionally be divided by the number of users on each day/week/month, the number of user sessions, runtime hours, etc.

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/reporting/eventTracking/basic/timeline/{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 '{
    "startDate": "2023-05-15",
    "stopDate": "2023-07-13",
    "dateSplit": "week",
    "dataView": "usageCounts",
    "divisor": null,
    "events": [
      {
        "combiArray": [
          {
            "category": "Reporting",
            "categoryType": "string",
            "name": "Send Email",
            "nameType": "string"
          }
        ],
        "combiLabel": "Reporting→ Send Email"
      }
    ]
  }'

Responses

OK

Headers
Serverstring
Example: "nginx/1.20.1"
Datestring
Example: "Thu, 13 Jul 2023 12:23:03 GMT"
Content-Typestring
Example: "application/json"
Content-Lengthinteger
Example: "669"
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
{
  "result": {
    "2023-05-15": [ … ],
    "2023-05-22": [ … ],
    "2023-05-29": [ … ],
    "2023-06-05": [ … ],
    "2023-06-12": [ … ],
    "2023-06-19": [ … ],
    "2023-06-26": [ … ],
    "2023-07-03": [ … ],
    "2023-07-10": [ … ]
  }
}

Advanced Events

Request

This report provides a detailed view into how users are using your tracked events. It is available only for events selected for "advanced tracking" on the Event Tracking Management tab of the Product page. This report contains data about how many users used each event, many times each event occurred in total, how many times each user performed each event on average, etc. It also returns a histogram for each event showing the distribution of how many times each user performed each event.

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/reporting/eventTracking/advanced/fullReport/{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 '{
    "startDate": "2022-01-01",
    "stopDate": "2023-05-30",
    "events": [
      {
        "category": "Reporting",
        "name": "Send Email"
      }
    ]
  }'

Responses

OK

Headers
Serverstring
Example: "nginx/1.20.1"
Datestring
Example: "Thu, 13 Jul 2023 12:23:03 GMT"
Content-Typestring
Example: "application/json"
Content-Lengthinteger
Example: "669"
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
{
  "result": {
    "detailedReport": [ … ]
  }
}

License Key Registry Management

Operations

Custom Event Tracking

Operations

Exception Tracking

Operations

Client Profile Report

Operations

Raw Data Exports

Operations