Request/Response Parameters Summary

POST /reporting/eventTracking/churn/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

Property	Description
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. • dateReportedLost (string)—When an installation is lost, it can either be shown as lost on the date it last contacted the Usage Intelligence servers (dateLastSeen) or else it can be shown as lost when it was declared lost (last date when it contacted Usage Intelligence + the number of days specified in daysUntilDeclaredLost) (dateDeclaredLost). Therefore, the permitted values are dateLastSeen and dateDeclaredLost. • 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. • 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 the Events property section. • lowerBounds (object)—Optional parameter to specify the lower bounds of each histogram. Must be used in conjunction with binUpperBounds. Details can be found in lowerBounds and binUpperBounds Properties. • binUpperBounds (object)—Optional parameter to specify the histogram bin bounds. Must be used in conjunction with lowerBounds. Details can be found in lowerBounds and binUpperBounds Properties.
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 • 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.