SEARCH Video by Metadata API

Many times you need to retrieve video data by searching the tags, categories, events, and/or title/description of a video. This API call will retrieve the videos associated with an organization and a bunch of metadata about those videos from a search query.

Searching for Videos via Metadata

This GET request retrieves the videos associated with your organization that have the specified private tags and/or private categories and/or events and/or title/description. 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

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

Please use search_metadata for future calls.

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. Note that if privateTags is omitted all videos with privateTags will be returned. 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
events	a comma-separated list of url-encoded strings	optional. videos containing any of the specified events will be returned. events are case sensitive. Examples: putting driver,Tiger%20Woods,Masters
titleString	a comma-separated list of url-encoded strings	optional. videos containing any of the specified words in their title or description will be returned. titleStrings are not case sensitive. Examples: putting driver,Tiger%20Woods,Masters
and	either 1 or 0	optional, defaults to 0. If ‘and’ is “1” and at least two of events, privateTags, and privateCategories are specified then the videos with the specified categories AND tags AND events will be returned. If ‘and’ is “0” (or omitted) then videos with the specified categories OR tags OR 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.
tagAnd	either 0 or 1	optional, defaults to 0. If tagAnd is “1” then videos matching all the specified tags will be returned. If tagAnd is “0” or omitted videos with any of the tags will be returned.
categoryAnd	either 0 or 1	optional, defaults to 0. If categoryAnd is “1” then videos matching all the specified categories will be returned. If categoryAnd is “0” or omitted videos with any of the categories will be returned.
eventAnd	either 0 or 1	optional, defaults to 0. If eventAnd is “1” then videos matching all the specified events will be returned. If eventAnd is “0” or omitted videos with any of the events will be returned.
titleAnd	either 0 or 1	optional, defaults to 0. If titleAnd is “1” then videos that have all of the titleStrings in the title or the descriptionwill be returned. If eventAnd is “0” or omitted videos with any of the strings in the title or description 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": [],
      "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"
    }
  ]
}

Note that you might have to play the API a bit, especially the “and” parameter. When you don’t explicitly request tags (ie: if you search for just events or categories) the “and” tag will limit the results to just the videos with the events/or categories specifieds. If the “and” tag is omitted or 0 it’ll give you all the tagged videos + the videos with events or categories specified.

Technically, it intersects the results of the explicit requests (ie: if event and category are searched for it’ll return the intersection of the videos in both events and categories).

If you specify tags + events it’ll do the intersection of those two results but if you just specify events then it’ll only return events (if and=1)