Sign up for free
  • VOD

Tags

get

List all video tags

This endpoint enables you to search for video tags in a project and see how many videos are tagged with them. If you do not define any query parameters, the endpoint lists all video tags and the numbers of times they are used in a project.

valuestring

Use this parameter to search for specific video tags. The API filters results even on partial values, and ignores accents, uppercase, and lowercase.

sortBystring

Use this parameter to choose which field the API will use to sort the response data. The default is value.

These are the available fields to sort by:

  • value: Sorts the results based on tag values in alphabetic order.
  • videoCount: Sorts the results based on the number of times a video tag is used.
Enum
  • value
  • videoCount
Example
"value"
sortOrderstring

Use this parameter to sort results. asc is ascending and sorts from A to Z. desc is descending and sorts from Z to A.

Enum
  • asc
  • desc
Example
"asc"
currentPageint

Choose the number of search results to return per page. Minimum value: 1

Default
1
Example
2
pageSizeint

Results per page. Allowed values 1-100, default is 25.

Default
25
Example
30

Responses

Response examples

Success

{
  "data": [
    {
      "value": "maths",
      "videoCount": "33"
    },
    {
      "value": "tutorials",
      "videoCount": "10"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "pageSize": 25,
    "pagesTotal": 1,
    "itemsTotal": 2,
    "currentPageItems": 2,
    "links": [
      {
        "rel": "self",
        "uri": "/tags?currentPage=1&pageSize=25"
      },
      {
        "rel": "first",
        "uri": "/tags?currentPage=1&pageSize=25"
      },
      {
        "rel": "last",
        "uri": "/tags?currentPage=1&pageSize=25"
      }
    ]
  }
}

Was this page helpful?