api.video
  1. Analytics
api.video
  • Account
    • Show account
      GET
  • Analytics
    • List live stream player sessions
      GET
    • List player session events
      GET
    • List video player sessions
      GET
  • Authentication
    • Authenticate
      POST
    • Refresh token
      POST
  • Live
    • List all live streams
      GET
    • Create live stream
      POST
    • Delete a live stream
      DELETE
    • Show live stream
      GET
    • Update a live stream
      PATCH
    • Delete a thumbnail
      DELETE
    • Upload a thumbnail
      POST
  • Players
    • List all players
      GET
    • Create a player
      POST
    • Delete a player
      DELETE
    • Show a player
      GET
    • Update a player
      PATCH
    • Delete logo
      DELETE
    • Upload a logo
      POST
  • Videos - Delegated upload
    • Upload with an upload token
      POST
    • List all active upload tokens.
      GET
    • Generate an upload token
      POST
    • Delete an upload token
      DELETE
    • Show upload token
      GET
  • Videos
    • List all videos
    • Create a video
    • Delete a video
    • Show a video
    • Update a video
    • Upload a video
    • Show video status
    • Pick a thumbnail
    • Upload a thumbnail
  • Captions
    • List video captions
    • Delete a caption
    • Show a caption
    • Update caption
    • Upload a caption
  • Chapters
    • List video chapters
    • Delete a chapter
    • Show a chapter
    • Upload a chapter
  • Webhooks
    • List all webhooks
    • Create Webhook
    • Delete a Webhook
    • Show Webhook details
  1. Analytics

List player session events

GET
/analytics/sessions/{sessionId}/events
Useful to track and measure video's engagement.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://ws.api.video/analytics/sessions/psEmFwGQUAXR2lFHj5nDOpy/events'
Response Response Example
200 - response
{
    "data": [
        {
            "at": 0,
            "emittedAt": "2020-09-15T09:47:42.000Z",
            "type": "ready"
        },
        {
            "at": 0,
            "emittedAt": "2020-09-15T21:35:57.000Z",
            "type": "play"
        },
        {
            "at": 7,
            "emittedAt": "2020-09-15T21:36:05.000Z",
            "type": "pause"
        },
        {
            "at": 21,
            "emittedAt": "2020-09-15T21:36:19.000Z",
            "type": "resume"
        },
        {
            "emittedAt": "2020-09-15T21:36:19.000Z",
            "from": 7,
            "to": 21,
            "type": "seek.forward"
        },
        {
            "at": 30,
            "emittedAt": "2020-09-15T21:36:28.000Z",
            "type": "end"
        },
        {
            "at": 0,
            "emittedAt": "2020-09-15T21:36:29.000Z",
            "type": "play"
        },
        {
            "emittedAt": "2020-09-15T21:36:29.000Z",
            "from": 30,
            "to": 0,
            "type": "seek.backward"
        },
        {
            "at": 21,
            "emittedAt": "2020-09-15T21:36:29.000Z",
            "type": "pause"
        },
        {
            "at": 21,
            "emittedAt": "2020-09-15T21:36:30.000Z",
            "type": "resume"
        },
        {
            "emittedAt": "2020-09-15T21:36:30.000Z",
            "from": 0,
            "to": 21,
            "type": "seek.forward"
        },
        {
            "at": 20,
            "emittedAt": "2020-09-15T21:36:33.000Z",
            "type": "pause"
        },
        {
            "at": 20,
            "emittedAt": "2020-09-15T21:36:33.000Z",
            "type": "resume"
        },
        {
            "emittedAt": "2020-09-15T21:36:33.000Z",
            "from": 24,
            "to": 20,
            "type": "seek.backward"
        },
        {
            "at": 17,
            "emittedAt": "2020-09-15T21:36:39.000Z",
            "type": "pause"
        },
        {
            "at": 17,
            "emittedAt": "2020-09-15T21:36:39.000Z",
            "type": "resume"
        },
        {
            "emittedAt": "2020-09-15T21:36:39.000Z",
            "from": 17,
            "to": 17,
            "type": "seek.forward"
        },
        {
            "at": 19,
            "emittedAt": "2020-09-15T21:36:41.000Z",
            "type": "pause"
        },
        {
            "at": 0,
            "emittedAt": "2020-09-17T09:20:47.000Z",
            "type": "ready"
        },
        {
            "at": 0,
            "emittedAt": "2020-09-17T09:41:01.000Z",
            "type": "ready"
        },
        {
            "at": 0,
            "emittedAt": "2020-09-17T09:41:08.000Z",
            "type": "ready"
        },
        {
            "at": 0,
            "emittedAt": "2020-09-17T09:41:10.000Z",
            "type": "play"
        },
        {
            "at": 1,
            "emittedAt": "2020-09-17T09:41:12.000Z",
            "type": "pause"
        },
        {
            "at": 1,
            "emittedAt": "2020-09-17T09:41:13.000Z",
            "type": "resume"
        },
        {
            "at": 3,
            "emittedAt": "2020-09-17T09:41:15.000Z",
            "type": "pause"
        }
    ],
    "pagination": {
        "currentPage": 1,
        "currentPageItems": 25,
        "itemsTotal": 30,
        "links": [
            {
                "rel": "self",
                "uri": "/analytics/sessions/ps5ltuhfsTOeh6bP03Tq5OWc/events?currentPage=1&pageSize=25"
            },
            {
                "rel": "first",
                "uri": "/analytics/sessions/ps5ltuhfsTOeh6bP03Tq5OWc/events?currentPage=1&pageSize=25"
            },
            {
                "rel": "next",
                "uri": "/analytics/sessions/ps5ltuhfsTOeh6bP03Tq5OWc/events?currentPage=2&pageSize=25"
            },
            {
                "rel": "last",
                "uri": "/analytics/sessions/ps5ltuhfsTOeh6bP03Tq5OWc/events?currentPage=2&pageSize=25"
            }
        ],
        "pageSize": 25,
        "pagesTotal": 2
    }
}

Request

Path Params

Query Params

Responses

🟢200Success
application/json
Body

🟠404Not Found
Modified at 2023-08-15 05:52:15
Previous
List live stream player sessions
Next
List video player sessions
Built with