Difference between revisions of "AddEventBatch"

From Gvp-public
Jump to navigation Jump to search
Line 27: Line 27:
 
|ParamType=String
 
|ParamType=String
 
|ParamRequired=optional
 
|ParamRequired=optional
|ParamDescription=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.
+
|ParamDescription=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.
 
: e.g.
 
:: "MediaInfo": "eyJNb3ZpZUlkIjozNTkzNiwiTWVkaWFJZCI6 … XlsaXN0SWQiOjAsIk1lZGlhVHlwZSI6MSwiRHVyYXRpb24iOjU4MjB9"
 
:: "MediaInfo": "eyJNb3ZpZUlkIjozNTkzNiwiTWVkaWFJZCI6 … XlsaXN0SWQiOjAsIk1lZGlhVHlwZSI6MSwiRHVyYXRpb24iOjU4MjB9"

Revision as of 19:17, 6 June 2014

Description

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.
{
"Timestamp" : "4315435114",
"Event" : "Play",
"Data" :
{"Param": "Value", "Param2": "Value2" }
}
  • 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