Request/Response Parameters Summary
POST /reporting/engagement/churnAndEngagement
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. |
|
•
|
daysUntilDeclaredLost (integer)—This specifies the number of consecutive days of inactivity that have to pass until a client installation is declared lost. |
|
•
|
dateSplit (string) – Whether to present results by day, week, or month. |
|
•
|
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)—The field with which to segment the data. Details about segmentation can be found in the Segmentation section. |
|
•
|
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 the Segmentation section. |
|
|
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. |
|