Results Format
The structure of the results depends on whether the categorizeEvents property is set to true or false, and whether segmentation is being used.
The simplest form is when events are not categorized and segmentation is disabled. In this case, the results property contains an array of objects each containing details about each event (event category and name), how many times the event occurred in total, how many times each event occurred per user on average, etc. When setting categorizeEvents to true, the results are presented into 2 levels. The results are still an array of objects, but each object consists of only 2 properties - eventCategory and categoryData. The categoryData value is an array of objects, and each object contains the data for one event within that particular category. The only difference is that this sub-object does not contain the eventCategory property since that property is already present in the upper level.
Segmentation adds another level in the results. When using segmentation, each event object contains a property named segments. The segments value is an array of objects, with each object containing data about one segment. The segment name can be found in the property value named segmentLabel. The rest of the properties are common with the properties inside the event objects.
The following are the properties contained in the data objects:
|
Property |
Description |
|
eventCategory (string) |
Present only in event objects when categorizeEvents is set to false. Contains the event category. |
|
eventName (string) |
Present in event objects. Contains the event name. |
|
segmentLabel (string) |
Present in segment objects. Contains the name/label of the segment. |
|
eventCount (integer) |
The total number of times that the event occurred. |
|
eventCountPerUserUsedAtLeastOnce (float) |
The average number of times that this event occurred for each client that performed this event at least once. |
|
eventCountPerUserUsedAtLeastOnceActiveDay (float) |
The average number of times that this event occurred per day for each client that performed this event at least once. |
|
eventCountPerUserUsedAtLeastOnceActiveWeek (float) |
The average number of times that this event occurred per week for each client that performed this event at least once. |
|
eventCountPerUserUsedAtLeastOnceActiveMonth (float) |
The average number of times that this event occurred per month for each client that performed this event at least once. |
|
usersUsedAtLeastOnce (integer) |
The number of clients which performed this event at least once. |
|
percentUsedAtLeastOnce (float) |
The percentage of clients which performed this event at least once. |
|
usersNeverUsed (integer) |
The number of clients which never performed this event. |
|
percentNeverUsed (float) |
The percentage of clients which never performed this event. |
|
segments (object) |
Present only in event objects when segmentation is being used. Contains an array of objects - one object for each segment. |
For more information, see:
| • | Example Response with No Event Categorization and No Segmentation |
| • | Example Response with Event Categorization and Segmentation by prodVersion |