Sign in
V3 > Metadata

List metadata.

Get a paginated list of metadata associated with the provided channel.

get/2/vod/channels/{channel}/metadata

Path parameters

channelstring required

Query parameters

return'total'

Optional : If you pass this parameter with the value total, then the response will be the number of items in the collection, instead of the items themselves.<br /> Part of the total capacity

pageinteger

Optional parameter that define the page number<br /> Part of the pagination capacity

per_pageinteger

Optional parameter that define the number of items per page<br /> Part of the pagination capacity

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

totalinteger

Total number of items Added when using query parameter page

pageinteger

Number of the current page Added when using query parameter page

pagesinteger

Total number of pages Added when using query parameter page

items_per_pageinteger

Number of items per page Added when using query parameter page

Example response

{
  "result": "success",
  "data": [
    {
      "id": 1,
      "name": "my product",
      "type": "file"
    }
  ],
  "total": 221,
  "page": 2,
  "pages": 15,
  "items_per_page": 15
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.