Results Format
If segmentation is not being used, the results are presented in an array of objects. Each object inside the array represents an event or a combination of events as requested. If segmentation is used, the data is presented as a JSON object. This object would contain an element for each segment, where the key would be the segment name, and the value would be an array containing event data as described above.
The inner objects inside the array/s contain the following elements:
| • | eventCounts—The total number of recorded occurrences of this event |
| • | averageEventCountPerSessionUsedAtLeastOnce—The average number of event occurrences per runtime session from installations which performed this event at least once within the specified date range |
| • | averageEventCountPerSessionAll—The average number of event occurrences per runtime session from all installations (including installations who did not perform this event) |
| • | averageEventCountPerUserAtLeastOnce—The average number of event occurrences per installations which performed this event at least once within the specified date range |
| • | averageEventCountPerUserAll —The average number of event occurrences per installation (including installations who did not perform this event) |
| • | uniqueUsersUsedAtLeastOnce—The number of unique installations/users who used this event at least once within the specified date range |
| • | uniqueUsersNeverUsed —The number of unique installations/users who never used this event within the specified date range |
| • | usageFrequency—Histogram data showing the number of times the event occurred by how many users. |
In the example below, no segmentation is being used. As described above, when segmentation is used, the results are presented in an object which contains an element for each segment having an array in the same format as below as the value.
Example Request
POST /reporting/eventTracking/advanced/fullReport HTTP/1.1
Host: api.revulytics.com
Content-Type: application/json
Accept: application/json
{
"user": "testuser@test.com",
"sessionId": "VSB8E2BzSC2eZSJm4QmTpA",
"productId": 12345678901,
"startDate": "2018-10-01",
"stopDate": "2018-12-31",
"events": [
{
"category": "File Operations",
"name":"Open"
},
{
"category": "File Operations",
"name":"Save"
}
]
}
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "OK",
"segmentBy": null,
"results": {
"detailedReport": [{
"category": "File Operations",
"name": "Save",
"data": {
"eventCounts": 81223,
"averageEventCountPerSessionUsedAtLeastOnce": 0.35,
"averageEventCountPerSessionAll": 0.28,
"averageEventCountPerUserAtLeastOnce": 27.46,
"averageEventCountPerUserAll": 22.85,
"uniqueUsersUsedAtLeastOnce": 2958,
"uniqueUsersNeverUsed": 596,
"usageFrequency": {
"1 - 5": 314,
"6 - 10": 352,
"11 - 15": 334,
"16 - 20": 315,
"21 - 25": 292,
"26 - 30": 316,
"31 - 35": 257,
"36 - 40": 214,
"41 - 45": 142,
"46 - 50": 116,
"51 - 60": 98,
"61 - 70": 51,
"\u2265 71": 157
}
}
}, {
"category": "File Operations",
"name": "Open",
"data": {
"eventCounts": 211161,
"averageEventCountPerSessionUsedAtLeastOnce": 0.73,
"averageEventCountPerSessionAll": 0.73,
"averageEventCountPerUserAtLeastOnce": 59.7,
"averageEventCountPerUserAll": 59.42,
"uniqueUsersUsedAtLeastOnce": 3537,
"uniqueUsersNeverUsed": 17,
"usageFrequency": {
"1 - 5": 192,
"6 - 10": 232,
"11 - 15": 211,
"16 - 20": 221,
"21 - 25": 210,
"26 - 30": 177,
"31 - 35": 178,
"36 - 40": 169,
"41 - 45": 153,
"46 - 50": 120,
"51 - 60": 252,
"61 - 70": 211,
"71 - 80": 173,
"81 - 90": 184,
"91 - 100": 156,
"101 - 110": 135,
"111 - 120": 107,
"121 - 130": 94,
"131 - 140": 69,
"141 - 150": 79,
"\u2265 151": 214
}
}
}]
}
}