AddEventBatch
Description
The AddEventBatch is a method to add massive events in just one request. The same behavior of AddEvent, his more common use is on mobile device (after stay offline during some time) or when the events can be send in a group of events. On mobile device in a offline mode, all events that wants to add can be storage in a pool, and when it become online, send all data in one request to the AddEventBatch.
The difference between AddEvent, is that the parameter eventData is an Array of AnalyticsEventItem that contains each event to add with his info like timestamp and event title.
The AddEventBatch can be used logged or anonymous.
For more information about the behavior, see AddEvent method.
NOTE: Each event in the array eventData has three members: timestamp, event and data. The data parameter could be create with dynamic fields as needed. It's composed by a sequence of key:value.
For example: If wants to send three groups of data and it has different name. The application should controls the sequence and send one at a time.
- First batch:
- - Timstamp: { now }
- - Event: FirstBatch
- - Data: [ Array of Event object with information ]
- Second batch
- - Timstamp: { now }
- - Event: SecondBatch
- - Data: [ Array of Event object with information ]
- Third batch
- - Timstamp: { now }
- - Event: ThirdBatch
- - Data: [ Array of Event object with information ]
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- eventData (AnalyticsEventItem, required)
- The eventData parameter is an AnalyticsEventItem object type and represent a set of data to register the event in the Mongo data base. Each event has the Timestamp, Event and an object with many pair of key:value. It allow to add any pair key:value as you need because it will be add in the Mongo database dynamically inserting a new column by each new key added.
- e.g.
- {
- Token: "",
- mediaInfo: "",
- eventData: [
- {
- "Timestamp" : "4315435114",
- "Event" : "EventName",
- "Data" :
- {
- "EventType":"STOP",
- "ChannelNumber":1,
- "ChannelName":"TVE 1",
- "ChannelCallLetter":"",
- "StreamQuality":"SD",
- "UniqueUserCode":null,
- "DeviceId":"3333333333332222222222227128",
- "OBInstanceCode":25,
- "UserType":null
- }
- {
- },
- {
- "Timestamp" : "34123543156",
- "Event" : "AnotherEventName",
- "Data" :
- {
- "EventType":"Rent",
- "ActionType":"Click",
- "ProductType":1,
- "DeviceId":"3333333333332222222222227128",
- "OBInstanceCode":29,
- "Advertising":null
- "MerchantId":123
- }
- {
- }
- {
- ]
- }
- {
- mediaInfo (String, optional)
- This parameter can be found in the GetMediaURL and has all information about the Movie. Is passed, it will be used to assign the eventData with the movie.
- e.g.
- "MediaInfo": "eyJNb3ZpZUlkIjozNTkzNiwiTWVkaWFJZCI6 … XlsaXN0SWQiOjAsIk1lZGlhVHlwZSI6MSwiRHVyYXRpb24iOjU4MjB9"
Returns
Returns a JSON object containing the information if the event is registered on server.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": true
}
Exceptions
None
Caching
This method is not cached.
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 1.0 | Initial method design | Harley Cabral |
| 2.4 | Ricardo Calvo
|
