Telemetry API documentation version v1

https://client-api.{environment}/api/tracker/{version}

  • environment: required(one of magine.com, tvoli.com - default: magine.com)
  • version: required(v1)

Introduction

Send events to Magine related to the users behaviour or playback

Playback events

  • playback_buffering
  • playback_buffering_type : "initial" ("seek", "intermediate", "initial")
  • duration: 120 (in milliseconds)
  • playlist_url: "http://www.magine.com/api/foo/bar"
  • asset_id: "r5345-345345-345dczv"
  • playback_video_bitrate: 34645
  • playback_audio_bitrate: 34645
  • playback_protocol: "hls"
  • playback_position: 0 (in milliseconds from start)
  • playback_play
  • playback_position: 420 (in milliseconds)
  • playback_video_bitrate: 34645
  • playback_audio_bitrate: 34645
  • playback_protocol: "hls"
  • playlist_url: "http://www.magine.com/api/foo/bar"
  • asset_id: "r5345-345345-345dczv"
  • playback_pause
  • playlist_url:"http://www.magine.com/api/foo/bar"
  • playback_video_bitrate: 34645
  • playback_audio_bitrate: 34645
  • playback_protocol: "hls"
  • playback_position: 100 (in milliseconds)
  • asset_id: "r5345-345345-345dczv"
  • playback_error
  • component: "/player/drm" The component were the error happened. See list of valid components
  • error_id: "drm" could be any string, however: errors should always have the same name, should not depend on userId/session/asset/whatever
  • playback_protocol: "hls"
  • error_code: 500,
  • asset_id: "r5345-345345-345dczv"
  • playlist_url: "http://www.magine.com/api/foo/bar"
  • api_request
  • key: "/user/settings" could be any string, however: key should always have the same name, should not depend on userId/session/asset/whatever
  • is_success: true
  • status_code: 404
  • message: "Page not found"
  • url: "http://www.magine.com/user/settings/1234567USR?update=true"

/telemetry-events

post

post

Headers

  • Authorization: required(string)

    Global header for authorisation on a normal JWT format.

  • Magine-AccessToken: required(string)

    Global header for all API requests to a specific partner.

Body

Media type: application/json

Type: TelemetryEvent | TelemetryEvent[]

Example:

[{
    "timestamp": 1235587,
    "source": "APP_ACTION",
    "component": "/player/engine",
    "action": "playback_buffering",
    "seqId": 1,
    "context": {
        "playback_buffering_type" : "initial",
        "duration": 12,
        "playlist_url": "http://www.magine.com/api/foo/bar",
        "asset_id": "r5345-345345-345dczv",
        "playback_bitrate": 34645,
        "playback_position": 0,
        "network_type": "wifi",
        "device_type": "smartphone",
        "device_model": "iphone 6",
        "device_platform": "apple",
        "device_id": "d2453ergdfzv-reagfdzgbx-fdg",
        "app_build": 123,
        "app_version": "1.26"
    },
    "extra": {
        "player_version": "0.1"
    }
}]

HTTP status code 202

Event(s) received normally

HTTP status code 400

Malformed request

HTTP status code 413

Too large request

/feedback

post

post

feedback

feedback

Body

Media type: application/json

Type: object

Properties
  • id: required(string)
  • data: required(object)

Example:

{
  "id": "subscription_canceled",
  "data": {
    "reason_id": “buffering”
    "reason_text": “Because of too much buffering”,
    "freetext": "There was a large amount of buffering yesterday and I could not stand it"
  }
}

HTTP status code 202

Accepted