API Reference
Login
Start typing to search…

List video views

get https://api.fastpix.io/v1/data/viewlist

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

How it works

  1. Make 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. Optionally, filter by viewerId, errorCode, orderBy a specific field, and sort in ascending or descending order.

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

Each view in the response will include a unique viewId. You can use this viewId to call the get details of video view endpoint to retrieve more detailed information about that specific view.

Example

Suppose you’re managing a video streaming service and need to analyze how the content performs across different devices and browsers. By calling the List Video Views endpoint with filters like browser_name and device_type, you can get insights into which platforms are most popular with the audience. This data will help you optimize content for the most-used platforms and troubleshoot any playback issues on less common devices.

Related guide: Audience metrics, Views dashboard

Log in to see full request history
Query Params
timespan[]
array
required

This parameter specifies the time span between which the video views list should 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.

timespan[]*
filterby[]
array

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.

filterby[]
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.

integer

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

Updated 6 days ago

Did this page help you?
Language
Credentials
:

Updated 6 days ago

Did this page help you?