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

Generic Date Range Reports

Request

This reporting mechanism is to be used for generating reports regarding user activity within a particular specified date range. Depending on the request, this can create timeline charts, pie/bar charts, geographical maps, or hierarchical tables.

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/generic/dateRange/{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 '{
    "clientStatus": [
      "new",
      "active",
      "lost"
    ],
    "startDate": "2023-05-15",
    "stopDate": "2023-07-13",
    "groupBy": "clientId",
    "daysUntilDeclaredLost": 40,
    "dateReportedLost": "dateDeclaredLost",
    "dateSplit": "week",
    "globalFilters": {
      "os": {
        "platform": {
          "value": [
            "Microsoft Windows"
          ]
        },
        "version": {
          "value": [
            "Microsoft Windows Server 2003"
          ]
        },
        "edition": {
          "value": [
            "Microsoft Windows 10 Home",
            "Microsoft Windows 10 Generic"
          ]
        },
        "type": "stringArray"
      },
      "geography": {
        "continent": {
          "value": [
            "AS",
            "EU"
          ]
        },
        "country": {
          "value": [
            "DZ",
            "BE",
            "AU"
          ]
        },
        "usState": {
          "value": [
            "US-LA",
            "US-IL",
            "US-FL"
          ]
        },
        "type": "stringArray"
      },
      "gpu": {
        "vendor": {
          "value": [
            "ATI",
            "AMD",
            "Intel",
            "NVIDIA"
          ]
        },
        "model": {
          "value": [
            "AMD Radeon HD 4600",
            "AMD Radeon HD 7000",
            "AMD Radeon R7 200"
          ]
        },
        "type": "stringArray"
      },
      "optOut": [
        {
          "historical": true,
          "current": true
        }
      ],
      "backOff": [
        {
          "historical": true,
          "current": true
        }
      ],
      "lifetimeEventUsage": [
        {
          "combiArray": [
            {
              "category": "File Operations",
              "categoryType": "string",
              "nameType": "regex",
              "name": ".*"
            },
            {
              "category": "File Operations",
              "name": "Copy",
              "categoryType": "string",
              "nameType": "string"
            },
            {
              "category": "File Operations",
              "name": "Clone",
              "categoryType": "string",
              "nameType": "string"
            },
            {
              "category": "File Operations",
              "name": "Open",
              "categoryType": "string",
              "nameType": "string"
            },
            {
              "category": "File Operations",
              "name": "Save",
              "categoryType": "string",
              "nameType": "string"
            }
          ],
          "max": 10000
        }
      ],
      "reachOutDeliveries": [
        {
          "auto": {
            "delivered": [
              "2"
            ],
            "undelivered": [
              "3"
            ]
          },
          "manual": {
            "delivered": [
              "1"
            ]
          }
        }
      ]
    },
    "resultMode": "absolute",
    "levels": {
      "level1": {
        "property": "prodVersion",
        "segments": [
          {
            "segmentLabel": "1.5-0",
            "type": "string",
            "value": "1.5"
          }
        ]
      }
    }
  }'

Responses

OK

Headers
Serverstring
Example: "nginx/1.20.1"
Datestring
Example: "Thu, 13 Jul 2023 09:29:17 GMT"
Content-Typestring
Example: "application/json"
Content-Lengthinteger
Example: "780"
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": { … }
  }
}

Generic Current Reports

Request

This reporting mechanism is to be used for generating reports regarding the current status of your product user base. Depending on the request, this can create pie/bar charts, geographical maps, or hierarchical tables.

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/generic/current/{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 '{
    "clientStatus": [
      "new",
      "active",
      "lost"
    ],
    "startDate": "2023-05-15",
    "daysUntilDeclaredLost": 40,
    "dateReportedLost": "dateDeclaredLost",
    "globalFilters": {},
    "levels": {
      "level1": {
        "property": "prodVersion",
        "segments": [
          {
            "type": "regex",
            "value": ".*",
            "split": true,
            "limit": 30,
            "includeNull": true
          }
        ],
        "sort": "active",
        "sortDirection": "desc"
      }
    },
    "groupBy": "clientId",
    "resultMode": "percentOfActive"
  }'

Responses

OK

Headers
Serverstring
Example: "nginx/1.20.1"
Datestring
Example: "Thu, 13 Jul 2023 12:42:38 GMT"
Content-Typestring
Example: "application/json"
Content-Lengthinteger
Example: "167"
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": {
    "level1": { … }
  }
}

User Engagement Histogram

Operations

Event Tracking Reports

Operations

License Key Registry Management

Operations

Custom Event Tracking

Operations

Exception Tracking

Operations

Client Profile Report

Operations

Raw Data Exports

Operations