Events Property
The events property consists of an array of objects each representing a single event or a combination of events which are to be grouped together and represented as if they were a single event.
To specify a single event, the events array would contain an object similar to the following example:
{
"category": "File Operations",
"name":"Open"
}
To specify a combination of events, the events array would contain an object that looks like the following:
{
"combiLabel": "Open and Save",
"combiArray": [
{
"categoryType": "string",
"nameType": "string",
"category": "File Operations",
"name": "Open"
},
{
"categoryType": "string",
"nameType": "string",
"category": "File Operations",
"name": "Save",
}
]
}
In the above example, we are combining the data from the Open and Save events, both under the File Operations category. In this example, “string” is being used both as categoryType and nameType. The other possible value is “regex”.
The following example shows a case where all events under the File Operations category are being combined:
{
"combiLabel": "All File Operations",
"combiArray": [
{
"categoryType": "string",
"nameType": "regex",
"category": "File Operations",
"name": ".*"
}
]
}
In order to allow more advanced reporting, it is also possible to apply different filters for each event using a property named eventFilters. This way, it is possible to compare usage of a property or group of properties between different user groups. The format for eventFilters is exactly the same as globalFilters.
In the following example, we are comparing how the clients that are on version 1.1 have used the “Open” event vs. those clients that are on version 2.0:
[
{
"category": "File Operations",
"name":"Open",
"eventFilters":
{
"prodVersion":
{
"type": "string",
"value": "1.1"
}
}
},
{
"category": "File Operations",
"name":"Open",
"eventFilters":
{
"prodVersion":
{
"type": "string",
"value": "2.0"
}
}
}
]
It is also possible to apply different filters to different events within the same combiArray. Note that the use cases for this kind of filtering are rather limited, and in most cases, this method of filtering is not advised unless you have very specific requirements. In the following example, we are requesting the “Open” event for version 1.1 combined with the “Save” event for version 2.0:
{
"combiLabel": "Open and Save in v1.1 and v2.0 respectively",
"combiArray": [
{
"categoryType": "string",
"nameType": "string",
"category": "File Operations",
"name": "Open",
"eventFilters":
{
"prodVersion":
{
"type": "string",
"value": "1.1"
}
}
},
{
"categoryType": "string",
"nameType": "string",
"category": "File Operations",
"name": "Save",
"eventFilters":
{
"prodVersion":
{
"type": "string",
"value": "2.0"
}
}
}
]
}