Skip to content

SEARCH Video List API

Many times you need to retrieve the content keys, titles, descriptions, etc for videos from a search query. This API call will retrieve the videos associated with an organization and a bunch of metadata about those videos from a search query.

Retrieve videos from a search query

This GET request retrieves the videos from your search query. Your organization key will be provided by ParOne.

GET https://search.parone.app/prod/search_video_list?organization_key=KEY&searchString=XXX

Call Parameters

ParameterValueComments
organization_keyThe organization key. Provided by ParOne.
searchStringthe search string, URL encodedMust be three characters or more long.

Return Value

This call will return a JSON object that has a list of videos for your organization.

{
"status" : "ok",
"message" : "ok",
"data": [
{
"content_key": "EdSGJ6kC",
"created_date": "2022-08-22T19:54:50.122Z",
"description": "The Callaway Golf Rogue ST irons are meant to serve as a successor to the Mavrik line, but borrow some inspiration from last year\u2019s Apex 21 irons. At the heart of this year\u2019s update is the all-new 450 A.I. Face Cup, a piece of performance-boosting tech Callaway is introducing to the golf industry with the Rogue ST line. We put the new Rogue ST Pro irons up against vs the Apex irons during GOLF Magazine's 2022 ClubTest... \n\nGOLF.com ClubTest Reviews: https://golfer.com/gear/\nFully Equipped Podcast: https://golfer.social/37YxrvA",
"duration": 36,
"parone_categories": [],
"privateCategory": [],
"privateTag": [],
"events" : [],
"removed": false,
"thumbnail": "https://thumbnails.parone.io/EdSGJ6kC.jpg",
"title": "Can the new Callaway Rogue ST Pro irons outperform Apex irons? | Proving Ground ClubTest 2022"
},
{
"content_key": "SeNBH62r",
"created_date": "2022-08-22T19:54:50.122Z",
"description": "private video 1080p",
"duration": 36,
"parone_categories": [],
"privateCategory": [],
"privateTag": [],
"events" : [],
"removed": false,
"thumbnail": "https://thumbnails.parone.io/SeNBH62r.jpg",
"title": "private 1080"
}
]
}

Structure of the Returned Results

The content_key and feed_code are used to parameterize the <parone-video-block>.

FieldValueComments
content_keyThe content key for this videoUsed across the ParOne API to identify a piece of content.
created_dateThe date the video was createdin UTC
descriptionThe video description
durationThe video’s duration, in seconds
parone_categoriesThe ParOne categories associated with this videoParOne categories are used for syndication
privateCategoriesThe private (organization-specific) categories associated with this video
privateTagsThe private (organization-specific) tags associated with this video
removedHas this video been removed from syndicationIf it’s removed it won’t be visible anywhere. This is the equivalent of a deleted video
thumbnailThe video’s thumbnail
titleThe video’s title

Syndications

FieldValueComments
nameThe name of the syndication
start_timeWhen the syndication startsIn UTC
stop_timeWhen the syndication stopsIn UTC
geosThe geographies for the syndicationCountry codes are three-letter country codes

Translations

FieldValueComments
languagetwo-letter language code
titleThe translated title of the video
descriptionThe translated description of the video