Difference between revisions of "AddEvent"

From Gvp-public
Jump to navigation Jump to search
Line 14: Line 14:
 
|ParamRequired=required
 
|ParamRequired=required
 
|ParamDescription=The eventData parameter is an Object from AnalyticsEvenItem type and represent a set of data to register the event in the data base.
 
|ParamDescription=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" } }.
+
: e.g.  
 +
:: { "Timestamp" : "4315435114",
 +
::  "Event" : "Play",
 +
::  "Data" :
 +
:::    {"Param": "Value", "Param2": "Value2" }
 +
:: }
 
}}
 
}}
 
{{Api_Parameter|
 
{{Api_Parameter|

Revision as of 15:26, 5 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 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