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 live stream player sessions

GET
/analytics/live-streams/{liveStreamId}
Analytics
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://ws.api.video/analytics/live-streams/vi4k0jvEUuaTdRAEjQ4Jfrgz'
Response Response Example
200 - response
{
  "data": [
    {
      "client": {
        "name": "Firefox",
        "type": "browser",
        "version": "61.0"
      },
      "device": {
        "model": "unknown",
        "type": "desktop",
        "vendor": "unknown"
      },
      "location": {
        "city": "Paris",
        "country": "France"
      },
      "os": {
        "name": "unknown",
        "shortname": "unknown",
        "version": "unknown"
      },
      "referrer": {
        "medium": "unknown",
        "searchTerm": "unknown",
        "source": "unknown",
        "url": "unknown"
      },
      "session": {
        "endedAt": "2018-09-11T14:47:22.186Z",
        "loadedAt": "2018-09-11T13:04:37.890Z",
        "sessionId": "ps4zRWVOv2If2vzKJLMr3jQo"
      }
    }
  ],
  "pagination": {
    "currentPage": 1,
    "currentPageItems": 1,
    "itemsTotal": 1,
    "links": [
      {
        "rel": "self",
        "uri": "/analytics/sessions/ps4zRWVOv2If2vzKJLMr3jQo?currentPage=1&pageSize=25"
      },
      {
        "rel": "first",
        "uri": "/analytics/sessions/ps4zRWVOv2If2vzKJLMr3jQo?currentPage=1&pageSize=25"
      },
      {
        "rel": "last",
        "uri": "/analytics/sessions/ps4zRWVOv2If2vzKJLMr3jQo?currentPage=1&pageSize=25"
      }
    ],
    "pageSize": 25,
    "pagesTotal": 1
  }
}

Request

Path Params
liveStreamId
string 
required
The unique identifier for the live stream you want to retrieve analytics for.
Example:
vi4k0jvEUuaTdRAEjQ4Jfrgz
Query Params
period
string 
optional
Period must have one of the following formats:
For a day : "2018-01-01",
For a week: "2018-W01",
For a month: "2018-01"
For a year: "2018"
For a range period:
Date range: "2018-01-01/2018-01-15"
Example:
"2019-01-01T00:00:00.000Z"
currentPage
integer 
optional
Choose the number of search results to return per page. Minimum value: 1
Example:
2
pageSize
integer 
optional
Results per page. Allowed values 1-100, default is 25.
Example:
30

Responses

🟢200Success
application/json
Body
data
array[object (Live Stream Session) {6}] 
optional
client
object (live_stream_session_client) 
optional
What kind of browser the viewer is using for the live stream session.
device
object (live_stream_session_device) 
optional
What type of device the user is on when in the live stream session.
location
object (live_stream_session_location) 
optional
The location of the viewer of the live stream.
os
object (video_session_os) 
optional
The operating system the viewer is on.
referrer
object (live_stream_session_referrer) 
optional
session
object (live_stream_session_session) 
optional
pagination
object (Pagination) 
optional
Example:
{"currentPage":3,"currentPageItems":20,"itemsTotal":123,"links":{"first":{"rel":"first","uri":"/videos/search?currentPage=1&pageSize=20"},"last":{"rel":"last","uri":"/videos/search?currentPage=6&pageSize=20"},"next":{"rel":"next","uri":"/videos/search?currentPage=4&pageSize=20"},"previous":{"rel":"previous","uri":"/videos/search?currentPage=2&pageSize=20"}},"pageSize":20,"pagesTotal":7}
currentPage
integer 
read-onlyoptional
The current page index.
currentPageItems
integer 
read-onlyoptional
The number of items on the current page.
itemsTotal
integer 
read-onlyoptional
Total number of items that exist.
links
array[object (PaginationLink) {2}] 
required
pageSize
integer 
read-onlyoptional
Maximum number of item per page.
pagesTotal
integer 
read-onlyoptional
Number of items listed in the current page.
🟠404Not Found
Modified at 2023-08-15 05:52:15
Previous
Show account
Next
List player session events
Built with