The video search API mimics the search within the Rev portal. All results are based on the authenticated user making the API request.

NOTE:

  • As of Rev v7.12, the speechResult response parameter is included when a search result also includes a speech search match.
  • As of Rev v7.12, the titleonly request parameter is available.
  • As of Rev v7.15, the sortDirection and sortField request parameters are available.
  • As of Rev v7.21, only exact parameter matches of the string yield a result.
GET
/api/v1/videos/search

Request Parameters

Name Type Description Required
q query search query string
type query Live / Vod
categories query GUID for specific categories. Can be multiple GUIDs separated by a comma. Using this parameter with no value will search uncategorized videos.
uploaders query Find videos for one or more specific users. Separate usernames with a comma.
uploaderIds query Find videos for one or more specific users. Separate user GUIDs with a comma.
status query Active / Inactive
count query Specific a number of videos to return. Defaults to 50 per page.
scrollId query If TotalVideos is greater than the Count value, then provide the scrollId returned from the first request to get the next set of videos.
titleOnly query true / false
sortField query If provided the query results will be sorted based on a field – title, whenUploaded, uploaderName, duration, _score.

Default sort is by title. Score is the relevance score (Rev portal defaults to relevance score based sorting).

sortDirection query asc / desc

Example Response

{
  "videos": [
  {
    "id": "f52a9f59-9838-4c6a-b4e6-e6ad3f404647",
    "title": "Football",
    "description": "20 seconds",
    "categories": [
      "13e22b98-e574-4e2b-b38f-b852c4851e8f",
      "a41a13e5-d3ce-4f7e-ab70-44de8821c7c1"
    ],
    "tags": [
      "Football",
      "Sports"
    ],
    "thumbnailUrl": "http://RevUrl/media/videos/thumbnails/cd7fce61-c45a-4784-a9d7-5a3b8dfc3df5.jpg",
    "playbackUrl": "http://RevUrl/embed?id=f52a9f59-9838-4c6a-b4e6-e6ad3f404647",
    "duration": "00:45:00",
    "viewCount": 5,
    "status": "Active",
    "approvalStatus": "Approved",
    "uploadedBy": "Mark",
    "whenUploaded": "2015-07-23T08:51:12.000Z"
  },
  {
    "id": "d34a9f59-9838-4c6a-b4e6-e6ad3f405678",
    "title": "Football_Repeat",
    "description": "20 seconds",
    "categories": [
      "13e22b98-e574-4e2b-b38f-b852c4851e8f"
    ],
    "tags": [
      "Sports"
    ],
    "thumbnailUrl": "http://RevUrl/media/videos/thumbnails/a9c75889-4204-44d4-8182-cac5e2899eac.jpg",
    "playbackUrl": "http://RevUrl/embed?id=d34a9f59-9838-4c6a-b4e6-e6ad3f405678",
    "duration": "01:15:00",
    "viewCount": 3,
    "status": "Active",
    "approvalStatus": "PendingApproval",
    "uploadedBy": "Mark",
    "whenUploaded": "2015-07-23T08:51:12.000Z",
    "speechResult": [
    {
      "time": "30:13"
      "text": "We're working"
    } ]
  } ],
  "totalVideos": 2,
  "scrollId": "cXVlcnlBbmRGZXRjaDsxOzI1NjU0OmZ6aDR1eUhBUlNtd2dLdlppVzhGRFE7MDs="
}

Response Codes

Code Description
200 ok
401 Unauthorized
500 Internal server error

Example – curl

REQUEST: Search for videos that match “test”

curl -X GET -H "Authorization: VBrick MY_TOKEN" "https://MY_REV_URL/api/v1/videos/search?q=test"

REQUEST: Get next page of search results (if more results available)

curl -X GET -H "Authorization: VBrick MY_TOKEN" "https://MY_REV_URL/api/v1/videos/search?q=test&scrollId=MY_SCROLL_ID"

This API only searches videos with the access control set to public.

This API does not require an authorization header.

GET
/api/v1/videos

Request Parameters

Name Type Description Required
categories query GUID for specific categories. Can be multiple GUIDs separated by a comma. Using this parameter with no value will search uncategorized videos.
getInActive query true / false

Example Response

{
  "videos": [
  {
    "videoId": "fe1530da-7938-4d92-b0e7-cfe81e71ad11",
    "title": "Keynote Speech",
    "description": "H264 Video",
    "thumbnailUrl": "http://RevUrl/media/videos/thumbnails/cd7fce61-c45a-4784-a9d7-5a3b8dfc3df5.jpg"
  },
  {
    "videoId": "196fb0f6-46ac-44e3-ae79-34caee70085d",
    "title": "On-Boarding Training",
    "description": "The video length is 3 minutes.",
    "thumbnailUrl": "http://RevUrl/media/videos/thumbnails/8072208e-c026-4503-a43c-ea77b4eafa96.jpg"
  } 
]
}

Response Codes

Code Description
200 ok
500 Internal server error