Results Format

The results consist of an array of JSON objects. Each object contains data about 1 single client. Each of these objects contain a clientId property as minimum. All other properties are optional and are dependent on the properties that were requested in the properties field, and whether reqDailyData has been specified. The current data (i.e. the last known values for each requested property for each client) is presented as properties in this object. The values are either strings, numbers or boolean values - depending on what each property contains.

If requested, the daily data is inside a property in the above mentioned object named dailyData. The value of this property is an array of objects - one object for each day on which the installation was active. As a minimum, each of these objects contain a date property formatted as YYYY-MM-DD. The rest of the properties depend on what properties were requested in the properties value of reqDailyData.

The reachOutDeliveries.auto and reachOutDeliveries.manual properties contain an array of objects. Each object refers to 1 reachOut campaign delivery. These objects contain 2 properties: reachoutID and name. The reachoutId is a numeric value given to each reachOut campaign as an identifier. The name is the campaign name as specified by the creator of the campaign. In case the reachOut campaign had been deleted, the value of the name property will be null.

The lifetimeEventUsage property contains data about all events performed by the client throughout the client lifetime. This is an array of objects. Each object contains 3 properties - eventCategory, eventName, and eventCount.