Results Format

The results object contains a hierarchy of sub-objects depending on how many segmentation levels were requested.

If at least 1 level was requested, the results object will contain only 1 member named level1. The value of level1 is a JSON object with a member for each segment of level 1. Therefore, assuming the level 1 property is prodVersion, the keys contain product versions or the segment labels that were specified. The value for each of these members will be an object containing an object named totals and if 2 or more levels were requested, another object named level2.

The totals object will contain up to 3 members - new, active, and lost, based on what was specified in the clientStatus property in the request. If the level2 object is present, it will be in the same format as level1. Similarly, the level2 object may contain an object named level3.

Refer to the following example for a sample request and response.

Full Example Request/Response of Daily Timeline Report with Segmentation
Results Format for Reports with No Segmentation Levels