SEARCH Video List
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
Section titled “Retrieve videos from a search query”This GET request retrieves the videos from your search query. Your organization key will be provided by ParOne.
GEThttps://search.parone.app/prod/search_video_list?organization_key=KEY&searchString=XXX
Call Parameters
Section titled “Call Parameters”| Parameter | Value | Comments |
|---|---|---|
| organization_key | The organization key. Provided by ParOne. | |
| searchString | the search string, URL encoded | Must be three characters or more long. |
Return Value
Section titled “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
Section titled “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 |
| description | The video description | |
| duration | The video’s duration, in seconds | |
| parone_categories | The ParOne categories associated with this video | ParOne categories are used for syndication |
| privateCategories | The private (organization-specific) categories associated with this video | |
| privateTags | The private (organization-specific) tags associated with this video | |
| removed | Has this video been removed from syndication | If it’s removed it won’t be visible anywhere. This is the equivalent of a deleted video |
| thumbnail | The video’s thumbnail | |
| title | The video’s title |
Syndications
Section titled “Syndications”| Field | Value | Comments |
|---|---|---|
| name | The name of the syndication | |
| start_time | When the syndication starts | In UTC |
| stop_time | When the syndication stops | In UTC |
| geos | The geographies for the syndication | Country codes are three-letter country codes |
Translations
Section titled “Translations”| Field | Value | Comments |
|---|---|---|
| language | two-letter language code | |
| title | The translated title of the video | |
| description | The translated description of the video |