Request/Response Parameters Summary
This report returns data that is to be represented in tabular format.
POST /reporting/eventTracking/lifetime/dataTable
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 on which to base 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. Details about these filters can be found in the Global Filters section. |
|
•
|
segmentBy (string)—he field with which to segment the data. Details about segmentation can be found in Segmentation. |
|
•
|
events (array)—Optional parameter to specify which events to include. 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. |
|
•
|
segments (string)—Used to specify how data is to be segmented. Must be used in conjunction with segmentBy. Details about segmentation can be found in Segmentation. |
|
•
|
categorizeEvents (boolean)—Whether to return events hierarchically based on category/event name (true) or return a flattened list (false). |
|
•
|
sorting (object)—Used to specify the values with which to sort and the direction. Details about this field can be found in Sorting. |
|
•
|
paging (object)—Optional parameter used to specify how many events to show and the index of the event to start with (starting from 0). These sub-parameters are named limit and startAt. Therefore, if showing 10 events per page and requesting page 3, limit should be set to 10 and startAt should be set to 20. |
|
|
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). |
|
•
|
segmentBy (string)—The same value that was passed as segmentBy in the request |
|
•
|
categorizeEvents (boolean)—The same value that was passed as categorizeEvents in the request |
|
•
|
results (object)—Contains the results as requested represented as a JSON object. The result format is described below in Results Format. |
|