Difference between revisions of "AnalyticsEventItem"
Line 2: | Line 2: | ||
|Description=Represent an Event object that has three parameters: timestamp, event and data. It can be used by AddEvent and AddEventBatch to add an event for the analytics tracking. Some metrics to analyze the navigation and behavior could generated by this values in the MIB Tools. | |Description=Represent an Event object that has three parameters: timestamp, event and data. It can be used by AddEvent and AddEventBatch to add an event for the analytics tracking. Some metrics to analyze the navigation and behavior could generated by this values in the MIB Tools. | ||
− | An important key can be set in the Data parameter. The '''context:true | + | An important key can be optional set in the Data parameter. The '''context:true/false''' key set if the user data will be obtained from the token or it will be sent with the other parameter to the AddEvent method. |
+ | If the context is set to true, all values will be obtained from the token param. If the context is set to false, all key:value should be sent in the data parameter, as USERID, COUNTRY, etc. By default, the context could be omitted and the default value is true. | ||
|Members= | |Members= |
Latest revision as of 14:28, 10 July 2014
Represent an Event object that has three parameters: timestamp, event and data. It can be used by AddEvent and AddEventBatch to add an event for the analytics tracking. Some metrics to analyze the navigation and behavior could generated by this values in the MIB Tools.
An important key can be optional set in the Data parameter. The context:true/false key set if the user data will be obtained from the token or it will be sent with the other parameter to the AddEvent method. If the context is set to true, all values will be obtained from the token param. If the context is set to false, all key:value should be sent in the data parameter, as USERID, COUNTRY, etc. By default, the context could be omitted and the default value is true.
Members
Field | Data Type | Description |
---|---|---|
Timestamp | String | A string with numbers that represent current date and time at the moment of the event has been add to the platform. |
Event | String | A name that identify the information registered by this event. |
Data | Object | Object that contains pair of key:values to set data info as much as needed about the event. |
Example
{
- "timestamp": 41324231,
- "event": "pulsando el botón de login",
- "data":
- {
- "EventType":"STOP",
- "ChannelNumber":1,
- "ChannelName":"TVE 1",
- "ChannelCallLetter":"",
- "StreamQuality":"SD",
- "UniqueUserCode":null,
- "DeviceId":"3333333333332222222222227128",
- "OBInstanceCode":25,
- "UserType":null,
- "Context": true
- }
- {
}
Known issues
None
Version history
API Version Number | Change description | Changes author |
---|---|---|
2.0 | Initial data type implementation | Harley Cabral |