GET Top Live Videos
Overview
The following table contains important information about the GET method in regards to receiving the top live videos for the platform.
| GET Top Live Videos | |
|---|---|
| Method | GET |
| URL or Endpoint | /api/v1/projects/projectId/dashboard/topLiveVideos |
| Headers | Authorization |
| Parameters | projectId, startDate, endDate, items, intervalType |
| Body | Not Applicable |
The description of the URL parameter is as follows:
| projectId URL Parameter | |
|---|---|
| URL Parameter Name | projectId |
| Mandatory | Yes |
| Type | string |
| Description | Unique Id of the project |
The description of the query parameters is as follows:
| Parameter Name | Mandatory | Type | Description |
|---|---|---|---|
| intervalType | No | integer($int32) | Determines the time interval for which the top videos are calculated. Available values: 0, 1, 2, 3, 4, 5, 6, 7, 8 |
| startDate | No | string($date-time) | The start date and time from which to begin collecting video data. |
| endDate | No | string($date-time) | The end date and time up to which to collect video data. |
| items | No | integer($int32) | The number of top videos to return. |
If no intervalType value is provided, the endpoint defaults to returning the top live videos for the last 24 hours.
To manually specify startDate and endDate, the intervalType parameter must be set to 5. Otherwise, any provided dates will be ignored.
Request Body
The request does not contain a request body.
Response
{
"success": true,
"errors": [
"string"
],
"messages": [
"string"
],
"result": [
{
"id": "string",
"thumbnailUrl": "string",
"isLiveStreaming": true,
"canEmbed": true,
"title": "string",
"author": "string",
"insertDate": "2025-10-29T12:33:03.696Z",
"plays": 0
}
],
"resultInfo": "string",
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
| Field Name | Type | Description |
|---|---|---|
| success | bool | If the response is successful it will return true. Otherwise will return false. |
| errors | array[string] | Indicates if there was an error. |
| messages | array[string] | Returns the response message from back-end. |
| result | array[object] | Returns the list of top videos along with their metadata and play counts. |
| id | string | Unique identifier of the video. |
| thumbnailUrl | string | URL of the video's thumbnail image. |
| isLiveStreaming | bool | Indicates whether the video is currently being live-streamed. |
| canEmbed | bool | Specifies whether the video can be embedded on external sites. |
| title | string | The title of the video. |
| author | string | The name of the video's creator or publisher. |
| insertDate | string($date-time) | The date and time when the video was uploaded or recorded. |
| plays | integer($int32) | The total number of plays for the video within the specified interval. |
| resultInfo | string | Returns extra information about the result. |
| statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed