Difference between revisions of "AddEventBatch"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the API s...") |
|||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
Description= | Description= | ||
| + | |||
|Parameters= | |Parameters= | ||
| Line 11: | Line 12: | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=eventData | ParamName=eventData | ||
| − | |ParamType=[[AnalyticsEventItem] | + | |ParamType=[[AnalyticsEventItem]] |
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=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" } | ||
| + | :: } | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 19: | Line 27: | ||
|ParamType=String | |ParamType=String | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription= | + | |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. | ||
| + | :: "MediaInfo": "eyJNb3ZpZUlkIjozNTkzNiwiTWVkaWFJZCI6 … XlsaXN0SWQiOjAsIk1lZGlhVHlwZSI6MSwiRHVyYXRpb24iOjU4MjB9" | ||
}} | }} | ||
| + | |||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing the | + | Returns a JSON object containing the information if the event is registered on server. |
'''Example:''' | '''Example:''' | ||
{ | { | ||
| − | : | + | : "StatusCode": 0, |
| + | : "Severity": 1, | ||
| + | : "StatusMessage": "OK", | ||
| + | : "Content": true | ||
} | } | ||
| + | |||
|Exceptions= | |Exceptions= | ||
Revision as of 19:16, 6 June 2014
Description
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 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
|
