editor
725
edits
Changes
Jump to navigation
Jump to search
{{Api_Method_Spec|Description= ( CANDIDATE TO BE DEPRECATED IN A SHORT FUTURE ) |Parameters={{Api_Parameter|ParamName=token|ParamType=String|ParamRequired=required|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.}}{{Api_Parameter|ParamName=eventData|ParamType=[[AnalyticsEventItem]]|ParamRequired=required|ParamDescription=The eventData parameter is an [[AnalyticsEventItem]] object type and represent a set of data to register the event in the Mongo data base. Each event has the Timestamp, Event and an object with many pair of key:value. It allow to add any pair key:value as you need because it will be add in the Mongo database dynamically inserting a new column by each new key added.: e.g. :: {::: Token: "",::: mediaInfo: "",::: eventData: [:::: {::::: "Timestamp" : "4315435114",::::: "Event" : "EventName",::::: "Data" :::::::: {:::::::: "EventType":"STOP",:::::::: "ChannelNumber":1,:::::::: "ChannelName":"TVE 1",:::::::: "ChannelCallLetter":"",:::::::: "StreamQuality":"SD",:::::::: "UniqueUserCode":null,:::::::: "DeviceId":"3333333333332222222222227128",:::::::: "OBInstanceCode":25,:::::::: "UserType":null::::::: }:::: },:::: {::::: "Timestamp" : "34123543156",::::: "Event" : "AnotherEventName",::::: "Data" :::::::: {:::::::: "EventType":"Rent",:::::::: "ActionType":"Click",:::::::: "ProductType":1,:::::::: "DeviceId":"3333333333332222222222227128",:::::::: "OBInstanceCode":29,:::::::: "Advertising":null:::::::: "MerchantId":123::::::: }:::: }::: ]:: }}}{{Api_Parameter|ParamName=mediaInfo|ParamType=String|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.: 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 |Cache=This method is not cached. |KnownIssues=None |VersionHistory={{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0" {{!}}- style="background:#88ccff;font-size:110%" ! API Version Number! Change description! Changes author {{!}}- valign="top"! 1.0{{!}} Initial method design{{!}} Harley Cabral {{!}}- valign="top"! 2.4{{!}} {{!}} Ricardo Calvo {{!}}} |SeeAlso=* [[AddEvent]]}}
no edit summary
