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

Retrieving and Searching License Keys From the Key Registry

Request

This request is used in order to get a list of license keys known by the Usage Intelligence servers along with their details. This is also used to search the key registry for a particular key or set of keys either by the key value itself or by another property such as by the expiry date or the assigned license type.

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/license-key-registry/{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 '{
    "filters": {},
    "sorting": {
      "field": "addedDate",
      "order": "ascending"
    },
    "paging": {
      "startAt": 0,
      "limit": 10
    }
  }'

Responses

OK

Headers
Serverstring
Example: "nginx/1.20.1"
Datestring
Example: "Thu, 13 Jul 2023 11:43:38 GMT"
Content-Typestring
Example: "application/json"
Content-Lengthinteger
Example: "4890"
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 Admin API (3.0.0.dev14)"
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
{
  "matchingKeysCount": 21,
  "returnedKeysCount": 10,
  "results": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

Updating New Keys in the Key Registry

Request

This request is used in order to update existing keys in the key registry. Keys can be updated one by one or in batch. A single batch can contain both new and existing keys to be inserted or updated accordingly.

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 PATCH \
  'https://rui-api.redocly.app/_mock/v3_api_redocly/v3/license-key-registry/update/{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 '{
    "licenseKey": "2c5bc269-ac2c-465c-8f07-25fa4930ce13",
    "licenseType": "purchased",
    "licenseStatus": {
      "activated": false,
      "blocked": false,
      "expired": false,
      "allowed": false
    },
    "installQuota": 2,
    "notes": "test"
  }'

Responses

Successful response

Bodyapplication/json
Response
application/json
null

Inserting New Keys in the Key Registry Copy

Request

This request is used in order to insert new keys into the key registry. Keys can be updated one by one or in batch. A single batch can contain both new and existing keys to be inserted or updated accordingly.

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/license-key-registry/update/{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 '{
    "licenseType": "purchased",
    "licenseStatus": {
      "activated": false,
      "blocked": false,
      "expired": false,
      "allowed": false
    },
    "installQuota": 2,
    "notes": "test"
  }'

Responses

Successful response

Bodyapplication/json
Response
application/json
null

Custom Event Tracking

Operations

Exception Tracking

Operations

Client Profile Report

Operations

Raw Data Exports

Operations