Difference between revisions of "AddEvent"

From Gvp-public
Jump to navigation Jump to search
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
Description=
+
Description=The AddEvent is a method to send a request with personalized information to be used by the BI team. This information is responsible to track any actions in the client app that use the GVP.
 +
The data record on the GVP is completely personalized and can be used for Player, Detail Page, Rent button, etc.
 +
The information is recorded in a Mongo Data Base, so it has a great power and scalable resources to storage all information.
 +
 
 +
To visualize the data, a tool will be developed to access on the MIB Tools, graphics, summarize, statistics and more. Predict to 2.4.6 GVP version.
 +
 
 +
Object sent to the Event service has three parameters: Token, MediaInfo and EventData. Token can be use logged or anonymous. The mediaInfo parameter is a info that can be get in all methods that return the URL Media.
  
 
|Parameters=
 
|Parameters=

Revision as of 14:45, 6 June 2014

Description

The AddEvent is a method to send a request with personalized information to be used by the BI team. This information is responsible to track any actions in the client app that use the GVP. The data record on the GVP is completely personalized and can be used for Player, Detail Page, Rent button, etc. The information is recorded in a Mongo Data Base, so it has a great power and scalable resources to storage all information.

To visualize the data, a tool will be developed to access on the MIB Tools, graphics, summarize, statistics and more. Predict to 2.4.6 GVP version.

Object sent to the Event service has three parameters: Token, MediaInfo and EventData. Token can be use logged or anonymous. The mediaInfo parameter is a info that can be get in all methods that return the URL Media.

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 Object from AnalyticsEvenItem type and represent a set of data to register the event in the data base.
e.g.
{
"Timestamp" : "4315435114",
"Event" : "Play",
"Data" :
{"Param": "Value", "Param2": "Value2" }
}
  • mediaInfo (String, optional)


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