Request/Response Parameters Summary
POST /reporting/eventTracking/advanced/fullReport
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. |
|
•
|
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 on which to base 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 Global Filters. |
|
•
|
segmentBy (string)—The field with which to segment the data. Details about segmentation can be found in the Data Segmentation. |
|
•
|
segments (array)— Optional JSON array that describes how data is to be split into segments. Refer to Data Segmentation. |
|
•
|
sort (string)—Optional property to specify how the segments are to be sorted. Possible values are alpha or eventCounts. If this property is not included, the data is sorted alphabetically by default. |
|
•
|
sortDirection (string)—Optional property to specify whether to sort in ascending or descending order. Possible values are asc and desc. If not specified, data is sorted in ascending order by default. |
|
•
|
events (array)—Array of objects specifying which events or combination of events to base the report on. Please refer to 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). |
|
•
|
results (array)—Present only if status is OK. Contains the list of available properties as described below. |
|