For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
StatusSupportDiscussionsLog inSign Up
Docs HomeAPI ReferenceVideo on DemandAI FeaturesLive StreamingVideo PlayerVideo DataCloud PlayoutRecipes
Docs HomeAPI ReferenceVideo on DemandAI FeaturesLive StreamingVideo PlayerVideo DataCloud PlayoutRecipes
  • ACTIVATE ACCOUNT
    • Create account
  • PRODUCT OS API
    • Overview
  • ERROR CODES
    • Error codes
  • VIDEO ON DEMAND API
    • Overview
  • LIVE STREAM API
    • Overview
  • VIDEO DATA API
    • Overview
      • GETList video views
      • GETGet details of video view
      • GETList by top content
LogoLogo
StatusSupportDiscussionsLog inSign Up
VIDEO DATA APIViews

List video views

GET
https://api.fastpix.com/v1/data/viewlist
GET
/v1/data/viewlist
$curl https://api.fastpix.com/v1/data/viewlist \
>     -u "<username>:<password>"
200Retrieved
1{
2  "success": true,
3  "data": [
4    {
5      "viewId": "92752c49-1bce-4cf8-bea4-5c2c2ac7575d",
6      "operatingSystem": "MacOS",
7      "application": "Chrome",
8      "viewStartTime": "2024-04-15T04:43:44",
9      "viewEndTime": "2024-04-15T04:44:05",
10      "videoTitle": "Champion Engagement Model: Best practices for identifying and engaging your champion",
11      "errorCode": null,
12      "errorMessage": null,
13      "country": "IN",
14      "viewWatchTime": 10016,
15      "QoeScore": 0.955924359113425,
16      "errorId": null
17    },
18    {
19      "viewId": "aa3f20e4-6065-4c7c-aed5-c7f8d127bcba",
20      "operatingSystem": "MacOS",
21      "application": "Chrome",
22      "viewStartTime": "2024-04-15T11:31:48",
23      "viewEndTime": "2024-04-15T11:32:30",
24      "videoTitle": "How to reduce time-to-value for your customers",
25      "errorCode": null,
26      "errorMessage": null,
27      "country": "IN",
28      "viewWatchTime": 31926,
29      "QoeScore": 0.958520302068513,
30      "errorId": null
31    },
32    {
33      "viewId": "d7e6929a-9b7f-4f88-a8eb-033fb9e6dc6d",
34      "operatingSystem": "MacOS",
35      "application": "Chrome",
36      "viewStartTime": "2024-04-15T20:34:42",
37      "viewEndTime": "2024-04-15T20:35:00",
38      "videoTitle": "Implementing projects the ISRO way",
39      "errorCode": null,
40      "errorMessage": null,
41      "country": "IN",
42      "viewWatchTime": 17562,
43      "QoeScore": 0.958648125844009,
44      "errorId": null
45    },
46    {
47      "viewId": "eca6400a-73e9-4250-8d0a-cb1cda15fed4",
48      "operatingSystem": "MacOS",
49      "application": "Chrome",
50      "viewStartTime": "2024-04-15T20:38:48",
51      "viewEndTime": "2024-04-15T20:39:23",
52      "videoTitle": "Designing your onboarding and adoption journey",
53      "errorCode": null,
54      "errorMessage": null,
55      "country": "IN",
56      "viewWatchTime": 34823,
57      "QoeScore": 0.956301364903515,
58      "errorId": null
59    },
60    {
61      "viewId": "687b3a54-6646-4343-bfbe-459742042f54",
62      "operatingSystem": "MacOS",
63      "application": "Chrome",
64      "viewStartTime": "2024-04-16T09:20:34",
65      "viewEndTime": "2024-04-16T09:21:24",
66      "videoTitle": "How to Approach an Irate Customer With Mimecast\"s Alice Jeffery",
67      "errorCode": null,
68      "errorMessage": null,
69      "country": "IN",
70      "viewWatchTime": 13493,
71      "QoeScore": 0.472563044953793,
72      "errorId": null
73    },
74    {
75      "viewId": "c1464fdb-f3f8-4ccd-8914-94e1851e8459",
76      "operatingSystem": "MacOS",
77      "application": "Chrome",
78      "viewStartTime": "2024-04-16T09:22:42",
79      "viewEndTime": "2024-04-16T09:22:45",
80      "videoTitle": "How to Approach an Irate Customer With Mimecast\"s Alice Jeffery",
81      "errorCode": null,
82      "errorMessage": null,
83      "country": "IN",
84      "viewWatchTime": 1,
85      "QoeScore": 0.5,
86      "errorId": null
87    }
88  ],
89  "pagination": {
90    "totalRecords": 27,
91    "currentOffset": 1,
92    "offsetCount": 3
93  },
94  "timespan": [
95    1712910924,
96    1713515724
97  ]
98}
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 <a href="https://docs.fastpix.io/reference/list_dimensions">list the dimensions</a> 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 <a href="https://docs.fastpix.io/reference/get_video_view_details">Get Video View Details</a> 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: <a href="https://docs.fastpix.io/docs/audience-metrics">Audience metrics</a>, <a href="https://docs.fastpix.io/docs/understand-dashboard-ui#1-views-dashboard">Views dashboard</a>
Was this page helpful?
Previous

Get details of video view

Next
Built with

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

Authentication

AuthorizationBasic
FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request. - <b>Username:</b> Access Token ID - <b>Password:</b> Secret Key Activate your FastPix account to generate your API credentials. <a href="https://docs.fastpix.io/docs/activate-account" target="_blank">See the guide here</a>

Query parameters

timespan[]enumOptional
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`
filterby[]stringOptional

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 ]

limitintegerOptionalDefaults to 10
Pass the limit to display only the rows specified by the value.
offsetintegerOptionalDefaults to 1
Pass the offset value to indicate the page number.
viewerIdstringOptional

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.

errorCodestringOptional
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.
orderBystringOptionalDefaults to view_end
Pass this value to sort the view list by.
sortOrderstringOptionalDefaults to asc
The order direction to sort the view list by.

Response

Get the list of Views
successboolean
Shows the request status. Returns true for success and false for failure.
datalist of objects
Displays the result of the request.
paginationobject
Pagination organizes content into pages for better readability and navigation.
timespanlist of integers
The timespan from and to details displayed in the form of unix epoch timestamps.

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

  • Username: Access Token ID
  • Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

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