Difference between revisions of "AddEventBatch"

From Gvp-public
Jump to navigation Jump to search
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
−
Description=The AddEventBatch is a method to add massive events in just one request. The same behavior of [[AddEvent]], the most common use is on mobile device or when the event can be grouped. On mobile device in a offline mode, all events that wants to add can be storage in a pool and it become online, send all data in one request to the AddEventBatch.
+
Description=The AddEventBatch is a method to add massive events in just one request. The same behavior of [[AddEvent]], the most 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 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 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.
Line 9: Line 9:
  
  
−
NOTE: If needed send a batch information, attempt that the event name is the name that will group the information and the timestamp represent only one moment for all data sent. In other word, when defined a event name, a group of data should be defined.
+
NOTE: Each event has the timestamp, event and data. The data parameter could be create with dynamic fields as needed. It's sent in a sequence of key:value.
−
To create another batch entry is necessary to create a new queue to group the other data under the new name of the event but controlled by the client side App.
 
−
 
 
−
The BI team should consider that each event is assigned to just one timestamp, so any metrics under this group event name should be happen in same time.
 
  
 
For example: If wants to send three groups of data and it has different name. The application should control the order to sent that.
 
For example: If wants to send three groups of data and it has different name. The application should control the order to sent that.
Line 46: Line 43:
 
: e.g.  
 
: e.g.  
 
:: {
 
:: {
−
:::  "Timestamp" : "4315435114",
+
:::  Token: "",
−
:::  "Event" : "Navigation",
+
:::  mediaInfo: "",
−
:::  "Data" :
+
:::  eventData: [
−
::::    [
+
::::  "Timestamp" : "4315435114",
−
:::::    {"ChannelListed": "channel_name1", "ProductId": "123" }
+
::::  "Event" : "Navigation",
−
:::::    {"PageViewed": "page_name1", "ProductId": "123" }
+
::::  "Data" :
−
:::::    {"ButtonClicked": "button_name1", "ProductId": "123" }
+
:::::    [
−
:::::    {"ButtonClicked": "button_name2", "ProductId": "123" }
+
::::::    {"ChannelListed": "channel_name1", "ProductId": "123" }
−
:::::    {"PageViewed": "page_name2", "ProductId": "456" }
+
::::::    {"PageViewed": "page_name1", "ProductId": "123" }
−
::::    ]
+
::::::    {"ButtonClicked": "button_name1", "ProductId": "123" }
 +
::::::    {"ButtonClicked": "button_name2", "ProductId": "123" }
 +
::::::    {"PageViewed": "page_name2", "ProductId": "456" }
 +
:::::    ]
 +
:::  ]
 
:: }
 
:: }
 
}}
 
}}

Revision as of 14:56, 13 June 2014

Description

The AddEventBatch is a method to add massive events in just one request. The same behavior of AddEvent, the most 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 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 has the timestamp, event and data. The data parameter could be create with dynamic fields as needed. It's sent in a sequence of key:value.

For example: If wants to send three groups of data and it has different name. The application should control the order to sent that.

  • First batch:
- Timstamp: { now }
- Event: DetailsNavigation
- Data: { object with information }
  • Second batch
- Timstamp: { now }
- Event: RentProcess
- Data: { object with information }
  • Third batch
- Timstamp: { now }
- Event: WatchingXperience
- Data: { object with information }

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
The eventData parameter is an AnalyticsEvenItem object type and represent a set of data to register the event in the Mongo data base.
e.g.
{
Token: "",
mediaInfo: "",
eventData: [
"Timestamp" : "4315435114",
"Event" : "Navigation",
"Data" :
[
{"ChannelListed": "channel_name1", "ProductId": "123" }
{"PageViewed": "page_name1", "ProductId": "123" }
{"ButtonClicked": "button_name1", "ProductId": "123" }
{"ButtonClicked": "button_name2", "ProductId": "123" }
{"PageViewed": "page_name2", "ProductId": "456" }
]
]
}
  • 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



See also

Retrieved from "https://wikis.tid.es/gvp-public/index.php?title=AddEventBatch&oldid=347"