Sign in
Raw statistics

List live stream player sessions

get/analytics/live-streams/{liveStreamId}

Path parameters

liveStreamIdstring required

The unique identifier for the live stream you want to retrieve analytics for.

Query parameters

periodstring period required

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"
currentPageinteger

Choose the number of search results to return per page. Minimum value: 1

pageSizeinteger

Results per page. Allowed values 1-100, default is 25.

Response

Success

Example response

{
  "pagination": {
    "itemsTotal": 123,
    "pagesTotal": 7,
    "pageSize": 20,
    "currentPage": 3,
    "currentPageItems": 20,
    "links": {
      "first": {
        "rel": "first",
        "uri": "/videos/search?currentPage=1&pageSize=20"
      },
      "previous": {
        "rel": "previous",
        "uri": "/videos/search?currentPage=2&pageSize=20"
      },
      "next": {
        "rel": "next",
        "uri": "/videos/search?currentPage=4&pageSize=20"
      },
      "last": {
        "rel": "last",
        "uri": "/videos/search?currentPage=6&pageSize=20"
      }
    }
  },
  "data": [
    {
      "referrer": {
        "searchTerm": "video stream",
        "medium": "organic",
        "source": "https://google.com",
        "url": "https://api.video"
      },
      "os": {
        "name": "Microsoft Windows",
        "shortname": "W10",
        "version": "Windows 10"
      },
      "session": {
        "loadedAt": "2019-06-24T11:45:01.109Z",
        "endedAt": "2019-06-24T12:45:01.109Z",
        "sessionId": "sessionId"
      },
      "client": {
        "name": "Firefox",
        "type": "browser",
        "version": "67.0"
      },
      "location": {
        "country": "France",
        "city": "Paris"
      },
      "device": {
        "vendor": "Dell",
        "model": "unknown",
        "type": "desktop"
      }
    },
    {
      "referrer": {
        "searchTerm": "video stream",
        "medium": "organic",
        "source": "https://google.com",
        "url": "https://api.video"
      },
      "os": {
        "name": "Microsoft Windows",
        "shortname": "W10",
        "version": "Windows 10"
      },
      "session": {
        "loadedAt": "2019-06-24T11:45:01.109Z",
        "endedAt": "2019-06-24T12:45:01.109Z",
        "sessionId": "sessionId"
      },
      "client": {
        "name": "Firefox",
        "type": "browser",
        "version": "67.0"
      },
      "location": {
        "country": "France",
        "city": "Paris"
      },
      "device": {
        "vendor": "Dell",
        "model": "unknown",
        "type": "desktop"
      }
    }
  ]
}

Changes