Request/Response Parameters Summary
POST /reporting/eventTracking/basic/timeline
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. |
|
•
|
dateSplit (string)—Whether to present results by day, week, or month. |
|
•
|
dataView (string)—Whether to show the counts of the number of times each event occurred (usageCount) or the total of the numeric custom values passed with each event (customValues). |
|
•
|
divisor (string)—Optional parameter to divide the data by a related value. The possible values are users, sessions, runtime, usageCounts. Note that usageCounts cannot be selected if dataView is set to usageCount. To get the raw values with no divisors, you may leave the divisor property out or set its value to null. |
|
•
|
events (array)—An array containing JSON objects, each containing a 2 string values - category and name. |
|
|
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 (object)—Contains the results as requested represented as a JSON object. The result format is described below. |
|