v1

latestOpenAPI 3.1.02026-07-2416666272.6 KB

Analytics API

Get video retention analytics

Retrieves retention analytics data showing viewer drop-off over time

get/retention/{video_id}

Path parameters

video_idstring uuid required

Unique identifier of the video

Query parameters

start_datestring date

Start date for analytics data

end_datestring date

End date for analytics data

Response

Video retention data retrieved successfully

retentionobject

Retention data indexed by second

viewsDataobject

Raw views data by second

Example response

{
  "retention": {
    "0": 100,
    "5": 95,
    "10": 90,
    "15": 85,
    "30": 70
  },
  "viewsData": {
    "0": 100,
    "5": 95,
    "10": 90,
    "15": 85,
    "30": 70
  },
  "video": {
    "title": "Sample Video",
    "duration": 300.5,
    "hls": "https://b-vz-abc123.tv.pandavideo.com.br/video123/playlist.m3u8",
    "retention_markers": [
      {
        "time": 30,
        "type": "pitch",
        "title": "Pitch Point"
      }
    ]
  }
}