GET Videos in a feed
Many times you need to retrieve the content keys, titles, descriptions, etc for videos. This call will retrieve the videos associated with an organization’s feed and metadata about those videos.
Retrieve videos from a feed
The easiest and fastest way to get the videos in a feed is by fetching this file via HTTPS:
Structure of the Returned Results
The content_key and feed_id are used to parameterize the <parone-video-block>
.
Field | Value | Comments |
---|---|---|
categories | The categories that the feed includes | |
events | The events that the feed includes | |
feed_id | The feed id, for reference | |
name | The feed name, which shows up in the ParOne UI | |
privateCategories | The private categories that the feed includes | |
privateTags | The private tags that the feed includes | |
content_key | The content key for this video | Used across the ParOne API to identify a piece of content. |
created_date | The date the video was created | in UTC |
videos | a list of videos |
The list of videos has the following fields:
Field | Value | Comments |
---|---|---|
description | The video description | |
categories | The parone categories associated with this video | |
privateCategories | The private categories associated with this video | |
privateTags | The private tags associated with this video | |
events | The events associated with this video | |
thumbnail | The video’s thumbnail | |
title | The video’s title |
The following call is deprecated.
This GET request retrieves the videos associated with your feed.
GET
https://videos-prod.parone.app/json-feed?feed=FEED_ID&start=START&count=COUNT
Call Parameters
Field | Value | Notes |
---|---|---|
feed | The feed ID containing the videos you want | |
start | the start of the results. 0 indexed | |
count | the maximum number of results to return |
Return Value
This call will return a JSON object that has a list of videos for the feed. Note that the total_videos field in each entry is the total numbers of videos in the feed, which allows you to page through the videos.
Structure of the Returned Results
The content_key and feed_code are used to parameterize the <parone-video-block>
.
Field | Value | Comments |
---|---|---|
content_key | The content key for this video | Used across the ParOne API to identify a piece of content. |
created_date | The date the video was created | in UTC |
start_date The date after which the video will be enabled | in UTC | |
video.description | The video description | |
categories | The parone categories associated with this video | |
video.thumbnail | The video’s thumbnail | |
video.title | The video’s title | |
video.translation | A list of Translations (see below). Each translation has a language, title, and description. | |
video.duration | The video duration, in seconds | |
total_videos | The total number of videos in the list | |
geos | The geographies for the video ”-” means all geos are allowed |
Translations
Field | Value | Comments |
---|---|---|
language | two-letter language code | |
title | The translated title of the video | |
description | The translated description of the video |