SEARCH Video List API

Requires ParOne Enterprise Player

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

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

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": [],
      "removed": false,
      "syndications": [
        {
          "name": "setting name",
          "start_date": "2022-08-22T19:54:50.122Z",
          "stop_date": "2022-08-22T19:54:50.122Z"
        }
      ],
      "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": [],
      "removed": false,
      "syndications": [
        {
          "name": "setting name",
          "start_date": "2022-08-22T19:54:50.122Z",
          "stop_date": "2022-08-22T19:54:50.122Z"
        }
      ],
      "thumbnail": "https://thumbnails.parone.io/SeNBH62r.jpg",
      "title": "private 1080",
      "translations": []
    }
  ]
}

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
syndications	A list of syndications (see below). Each syndication has a start_time, stop_time, a name, and geo field that controls when a video is shown.	Customers may have content that’s active in one geo during one date range and another during another date range, due to broadcast rights agreements. Dates are in UTC
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
translation	A list of Translations (see below). Each translation has a language, title, and description

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

Field	Value	Comments
language	two-letter language code	See Localization for more info
title	The translated title of the video
description	The translated description of the video

Searching for Videos via a Private Category or Tag

This GET request retrieves the videos associated with your organization that have the specified private tags and/or private categories. Your organization key will be provided by ParOne. Categories and tags are case-sensitive.

GET https://search.parone.app/prod/get_video_by_cattag?organization_key=KEY&categoryString=XX&tagString=YY&and=0

Call Parameters

Paramater	Value	Comments
organization_key	the organization key provided by ParOne
privateTags	a comma-separated list of url-encoded strings	optional. videos containing any of the specified tags will be returned. Tags are case sensitive. Examples: putting driver,Tiger%20Woods,Masters
privateCategories	a comma-separated list of url-encoded strings	optional. videos containing any of the specified categories will be returned. Categories are case sensitive. Examples: golf%20instruction golf%20instruction,Equipment,Reviews
and	either 1 or 0	optional, defaults to 0. If ‘and’ is “1” then videos with the specified categories AND tags will be returned. If ‘and’ is “0” (or omitted) then videos with the specified categories OR tags will be returned. Examples: privateTags: putting privateCategories: Golf%20Instruction If and=1 then videos that are tagged “putting” AND have the category “Golf Instruction” will be returned. If and=0 then videos that are tagged “putting” OR have the category “Golf Instruction” will be returned.

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://golf.com/gear/\nFully Equipped Podcast: https://golf.social/37YxrvA",
      "duration": 36,
      "parone_categories": [],
      "privateCategory": [],
      "privateTag": [],
      "removed": false,
      "syndications": [
        {
          "name": "setting name",
          "start_date": "2022-08-22T19:54:50.122Z",
          "stop_date": "2022-08-22T19:54:50.122Z"
        }
      ],
      "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": [],
      "removed": false,
      "syndications": [
        {
          "name": "setting name",
          "start_date": "2022-08-22T19:54:50.122Z",
          "stop_date": "2022-08-22T19:54:50.122Z"
        }
      ],
      "thumbnail": "https://thumbnails.parone.io/SeNBH62r.jpg",
      "title": "private 1080",
      "translations": []
    }
  ]
}