Results Format
The results are formatted as an array which contains a JSON object for each category. Each of these objects has a property named “category” which refers to the category names of the events. If there are events that were not assigned a category, they can be found under a category named null.
Each of these objects contains 3 other keys - categoryUsageSummary, categoryCustomValuesSummary, and categoryEventsData. The first two contain objects that contain values regarding the totals for each category.
In the below example, the events in the File Operations category occurred for a total of 554 times. This is displayed in the cumulativeUsageCount property inside categoryUsageSummary.
The categoryEventsData object, contains data about each individual event type in that particular category. This object contains a number of sub-objects, each referring to a particular event name. The keys refer to the event names. Each of these sub-objects contain 2 keys - eventUsage and eventCustomValues. These contain the data values for individual events. For example, the event Menu Launched inside the Print Operations category occurred only 1 time, and the total numeric custom value collected by this event was 1.29.
Example Request
POST /reporting/eventTracking/basic/dataTable HTTP/1.1
Host: api.revulytics.com
Content-Type: application/json
Accept: application/json
{
"user": "testuser@test.com",
"sessionId": "VSB8E2BzSC2eZSJm4QmTpA",
"productId": 12345678901,
"startDate": "2018-08-01",
"stopDate": "2018-08-03"
}
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "OK",
"results": [
{
"category": "File Operations",
"categoryUsageSummary": {
"cumulativeUsageCount": 554,
"averageCountPerUser": 1.01,
"averageCountPerSession": 0.21,
"averageCountPerRuntimeHour": 0.01
},
"categoryCustomValuesSummary": {
"cumulativeCustomValueCount": 2495.03,
"averageCustomValuePerEvent": 4.66,
"averageCustomValuePerUser": 4.71,
"averageCustomValuePerSession": 0.99,
"averageCustomValuePerRuntimeHour": 0.03
},
"categoryEventsData": {
"Open": {
"eventUsage": {
"cumulativeUsageCount": 455,
"averageCountPerUser": 0.71,
"averageCountPerSession": 0.15,
"averageCountPerRuntimeHour": 0.24
},
"eventCustomValues": {
"cumulativeCustomValueCount": 2118.31,
"averageCustomValuePerEvent": 4.66,
"averageCustomValuePerUser": 3.3,
"averageCustomValuePerSession": 0.69,
"averageCustomValuePerRuntimeHour": 1.11
}
},
"Save": {
"eventUsage": {
"cumulativeUsageCount": 99,
"averageCountPerUser": 0.15,
"averageCountPerSession": 0.03,
"averageCountPerRuntimeHour": 0.05
},
"eventCustomValues": {
"cumulativeCustomValueCount": 376.72,
"averageCustomValuePerEvent": 3.81,
"averageCustomValuePerUser": 0.59,
"averageCustomValuePerSession": 0.12,
"averageCustomValuePerRuntimeHour": 0.2
}
}
}
},
{
"category": "Print Operations",
"categoryUsageSummary": {
"cumulativeUsageCount": 418,
"averageCountPerUser": 0.65,
"averageCountPerSession": 0.14,
"averageCountPerRuntimeHour": 0
},
"categoryCustomValuesSummary": {
"cumulativeCustomValueCount": 563.37,
"averageCustomValuePerEvent": 1.35,
"averageCustomValuePerUser": 0.88,
"averageCustomValuePerSession": 0.18,
"averageCustomValuePerRuntimeHour": 0
},
"categoryEventsData": {
"Edit Mode": {
"eventUsage": {
"cumulativeUsageCount": 224,
"averageCountPerUser": 0.35,
"averageCountPerSession": 0.07,
"averageCountPerRuntimeHour": 0.12
},
"eventCustomValues": {
"cumulativeCustomValueCount": 149,
"averageCustomValuePerEvent": 0.67,
"averageCustomValuePerUser": 0.23,
"averageCustomValuePerSession": 0.05,
"averageCustomValuePerRuntimeHour": 0.08
}
},
"Preview Mode": {
"eventUsage": {
"cumulativeUsageCount": 141,
"averageCountPerUser": 0.22,
"averageCountPerSession": 0.05,
"averageCountPerRuntimeHour": 0.07
},
"eventCustomValues": {
"cumulativeCustomValueCount": 274,
"averageCustomValuePerEvent": 1.94,
"averageCustomValuePerUser": 0.43,
"averageCustomValuePerSession": 0.09,
"averageCustomValuePerRuntimeHour": 0.14
}
},
"Button Clicked": {
"eventUsage": {
"cumulativeUsageCount": 52,
"averageCountPerUser": 0.08,
"averageCountPerSession": 0.02,
"averageCountPerRuntimeHour": 0.03
},
"eventCustomValues": {
"cumulativeCustomValueCount": 139.08,
"averageCustomValuePerEvent": 2.67,
"averageCustomValuePerUser": 0.22,
"averageCustomValuePerSession": 0.05,
"averageCustomValuePerRuntimeHour": 0.07
}
},
"Menu Launched": {
"eventUsage": {
"cumulativeUsageCount": 1,
"averageCountPerUser": 0,
"averageCountPerSession": 0,
"averageCountPerRuntimeHour": 0
},
"eventCustomValues": {
"cumulativeCustomValueCount": 1.29,
"averageCustomValuePerEvent": 1.29,
"averageCustomValuePerUser": 0,
"averageCustomValuePerSession": 0,
"averageCustomValuePerRuntimeHour": 0
}
}
}
}
]
}