List video player sessions

Retrieve all available user sessions for a specific video. Tutorials that use the analytics endpoint.

{ "data": [ { "client": { "name": "Firefox", "type": "browser", "version": "67.0" }, "device": { "model": "unknown", "type": "desktop", "vendor": "Dell" }, "location": { "city": "Paris", "country": "France" }, "os": { "name": "Microsoft Windows", "shortname": "W10", "version": "Windows10" }, "referrer": { "medium": "organic", "searchTerm": "video encoding hosting and delivery", "source": "https://google.com", "url": "https://api.video" }, "session": { "endedAt": "2019-06-24T11:49:19.243Z", "loadedAt": "2019-06-24T11:45:01.109Z", "sessionId": "psEmFwGQUAXR2lFHj5nDOpy" } } ], "pagination": { "currentPage": 1, "currentPageItems": 1, "itemsTotal": 1, "links": [ { "rel": "self", "uri": "/analytics/sessions/psEmFwGQUAXR2lFHj5nDOpy?currentPage=1&pageSize=25" }, { "rel": "first", "uri": "/analytics/sessions/psEmFwGQUAXR2lFHj5nDOpy?currentPage=1&pageSize=25" }, { "rel": "last", "uri": "/analytics/sessions/psEmFwGQUAXR2lFHj5nDOpy?currentPage=1&pageSize=25" } ], "pageSize": 25, "pagesTotal": 1 } }

Request

Path Params

videoId

string

required

The unique identifier for the video you want to retrieve session information for.

Example:

vi4k0jvEUuaTdRAEjQ4Prklg

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

metadata

array[string]

optional

Metadata and Dynamic Metadata filter. Send an array of key value pairs you want to filter sessios with.

Example:

[{"key":"Author","value":"John Doe"},{"key":"Format","value":"Tutorial"}]

currentPage

integer

optional

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

Example:

pageSize

integer

optional

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

Example:

Responses

🟢200Success

application/json

Body

data

array[object (Video Session) {6}]

optional

client

object (video_session_client)

optional

What kind of browser the viewer is using for the video session.

device

object (video_session_device)

optional

What type of device the user is on when in the video session.

location

object (video_session_location)

optional

The location of the viewer.

object (video_session_os)

optional

The operating system the viewer is on.

referrer

object (video_session_referrer)

optional

session

object (video_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