Request/Response Parameters Summary
POST /reporting/eventTracking/lifetime/histogram
The request and response are both JSON objects. The following is a summary of the properties inside the request and response objects.
Request Properties
|
|
|
|
Request JSON Object
|
|
•
|
user (string)—The username of your Usage Intelligence user account. Required only for non-cookie authentication. |
|
•
|
sessionId (string)—The sessionId obtained via POST /auth/login. Required only for non-cookie authentication. |
|
•
|
productId (integer)—The product ID on which this request is being done. |
|
•
|
groupBy (string)—Optional parameter to specify the property with which to group installations. By default, this value is considered to be clientId. Other possible options are machineId, licenseKey or any custom property of type 3. |
|
•
|
startDate (string)—The first date of the date range during which users must be active in order to be included in the report. This is to be formatted as YYYY-MM-DD. |
|
•
|
stopDate (string)—The last date of the date range during which users must be active in order to be included in the report. This is to be formatted as YYYY-MM-DD. |
|
•
|
globalFilters (object)—JSON object containing the filters to be applied to the available data. These work exactly the same as in the data table report. Details can be found in Global Filters. |
|
•
|
events (array)—Array of objects specifying which events to include in the result. Supports both single events and event combinations. Details can be found in Events Property. |
|
|
Response JSON Object
|
|
•
|
status (string)—Contains OK if successful or SYNTAX ERROR or AUTH ERROR. |
|
•
|
reason (string)—Present only if status is not OK. Contains error message (reason). |
|
•
|
summary (object)—Contains the number of clients who performed each event at least once and the number of clients which never performed each event. The summary data format is described in Results Histograms. |
|
•
|
histograms (object)—Contains the histogram data as requested represented as a JSON object. The histogram data format is described in Results Histograms. |
|