cURL Header

api-key specify your api-key to get access to API
user-client-token user client token
user-access-token user access token

response-type specify API response type : ("json" or "xml")
api-version specify required API version : ("v1.0" o "v1.1")

Insert hits

URL :

 http://api.westream.com/analytics/insert/event

Response :

{
    "message":"Hit insert",
    "code":200,
    "success":true
}

Parameters :

idVideo(string) event(play/pause/complete) browser(string) ipAddress(userIP)

VOD

URL :

 http://api.westream.com/analytics/overview/vod

Response :

{
    "message":
                [
                    {
                        "idVideo":"abcd1234",
                        "title":"test title",
                        "date":"2016-03-04 16:45:52",
                        "count":"36"
                    },
                    {...}
                ],
    "code":200,
    "success":true
}

Parameters :

username(string)

URL :

 http://api.westream.com/analytics/overview/vod/browser

Response :

{
    "message":
                [
                    {
                        "idVideo":"abcd1234",
                        "title":"test title",
                        "date":"2016-03-04 16:45:52",
                        "count":"36"
                    },
                    {...}
                ],
    "code":200,
    "success":true
}

Parameters :

username(string)

LIVE

URL :

 http://api.westream.com/analytics/overview/live

Response :

{
    "message":
                [
                    {
                        "idLive":"abcd1234",
                        "title":"test title",
                        "date":"2016-03-04 16:45:52",
                        "count":"36"
                    },
                    {...}
                ],
    "code":200,
    "success":true
}

Parameters :

username(string)

URL :

 http://api.westream.com/analytics/overview/live/browser

Response :

{
    "message":
                [
                    {
                        "idVideo":"abcd1234",
                        "title":"test title",
                        "date":"2016-03-04 16:45:52",
                        "count":"36"
                    },
                    {...}
                ],
    "code":200,
    "success":true
}

Parameters :

username(string)

Output response example 

{
    "api_version": "v1.1"
    "results":
                [
                    { ... },
                    { ... }
                ],
    "message" : " ... ",
    "status_code" : "200",
    "success" : "true/false",
    "errors":
                {
                    "err_message" : " test error",
                    "err_code" : 34
                }
}
                        
{
    "api_version": "v1.0"
    "message":
                [
                    { ... },
                    { ... }
                ],
    "code" : "200",
    "success" : "true/false",
}

Errors

200 : Ok - Success!!

201 : Created

204 : Non content - There was no data to return.

400 : bad request - The request was invalid or cannot be otherwise served.

401 : Unauthorized - Authentication credentials were missing or incorrect.

403 : forbidden - The request is understood, but it has been refused or access is not allowed.

404 : Not found - The URI requested is invalid or the resource requested, such as a user, does not exists.

406 : Not Acceptable

500 : Internal Server Error - Something is broken.