Usage Intelligence Reporting API v2.0.0 Guide

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.

The Usage Intelligence Reporting API v2.0.0 Guide is organized into the following sections.

Usage Intelligence Reporting API v2.0.0 Guide

Section

Description

Quick Start Guide

Helps you learn how to use the API by trying out simple queries, and then start working on more complex queries.

POST vs GET Requests

Explains the two request method options - HTTP POST or HTTP GET requests.

Raw vs. Formatted Responses

Describes the two major methods to retrieve data - either in raw JSON format, or else in readily-formatted charts or tables wrapped in an HTML page.

Authentication

Explains how to authenticate, obtain a session ID, and log out.

Metadata Queries

Lists what filters are available and what filter values are possible.

Event Tracking Management

Explains how to create request to get a list of event names and categories that have been reported by your application to Usage Intelligence, know which ones have been enabled for collection, and also set which ones should be collected.

Generic Reports

Describes the date-range and current date reports, which show new, active, and lost users, and which can then be split by a number of segmentation options such as by country, by product version, etc.

User Engagement Histograms

Describes the User Engagement Histogram Report, which shows the number of days clients were active within the specified date range, number of times users launched your application, and the total amount of time, in hours, users spent interacting with your application.

Event Tracking Reports

These reports are meant to provide insight of what features in your product are most popular and how they are used.

Churn-Related Reports

This collection of reports is meant to provide insight on the lifetime of lost users. These reports are meant to report what happened during the whole lifetime of these installations rather than what happened during a defined date range.

License Key Registry Management

This section explains how to retrieve and search license keys from the key registry, and how to update and insert new keys in the key registry.

Custom Event Tracking

In Custom Event Tracking reports, data can either be previewed by retrieving the latest data in JSON format or else, zipped CSV files can be downloaded for offline processing.

Exception Tracking

In Exception Tracking reports, data can either be previewed by retrieving the latest data in JSON format or else, zipped CSV files can be downloaded for offline processing.

Client Profile Report

This report retrieves a subset or all of the data about a client or a set of clients.

Raw Data Export

Explains how to download raw data export files. The list of files can be retrieved, and then a temporary URL may be requested for downloading.