List video views

Retrieves a list of video views that fall within the specified filters and have been completed within a defined timespan. It lets you to analyse viewer interactions with your video content effectively.

How it works

  1. Send a GET request to this endpoint with the desired query parameters.

  2. Specify the timespan for which you want to retrieve the video views using the timespan[] parameter.

  3. Filter the views based on dimensions such as browser, device, video title, viewer ID, etc., using the filterby[] parameter. Get the dimensions by calling list the dimensions endpoint.

  4. Paginate the results using the limit and offset parameters.

  5. You can also filter by viewerId, errorCode, orderBy a specific field, and sortOrder in ascending or descending order.

  6. You receive a response containing the list of video views matching the specified criteria.

Each view in the response includes a unique viewId. You can use this viewId with the Get Video View Details endpoint to retrieve more detailed information about that specific view.

Example

If you manage a video streaming service and want to analyze content performance across devices and browsers. By calling the List Video Views endpoint with filters such as browser_name and device_type, you can identify which platforms are most popular with your audience. This information helps optimize content for widely used platforms and troubleshoot playback issues on less common devices.

Related guide: Audience metrics, Views dashboard

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

This parameter specifies the time span between which the video views list must be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.

Accepted formats are:

array of epoch timestamps for example
timespan[]=1498867200&timespan[]=1498953600

duration string for example
timespan[]=24:hours or timespan[]=7:days

Allowed:
string

Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass "!" before the filter value. The list of filters can be obtained from list of dimensions endpoint. Example Values : [ browser_name:Chrome , os_name:macOS , !device_name:Galaxy ]

integer
Defaults to 10

Pass the limit to display only the rows specified by the value.

integer
Defaults to 1

Pass the offset value to indicate the page number.

string

Pass the viewer_id to filter the list of views. This value can be manually set during integration or generated by FastPix. When set manually it can be a string of aplha numeric values of any length.

string | null

Pass the error code to filter the list of views. The possible values of error code can be fetched from list of errors end point.

string
Defaults to view_end

Pass this value to sort the view list by.

string
Defaults to asc

The order direction to sort the view list by.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json