Get the details of featured video collections

v1.0.0

This endpoint gets more detailed information about a featured video collection, including its cover video and timestamps for its creation and most recent update. To get the videos, use GET /v2/videos/collections/featured/{id}/items.

Input

{
  "type": "object",
  "properties": {
    "embed": {
      "type": "string",
      "enum": [
        "share_url"
      ]
    },
    "id": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Metadata about a featured collection",
  "required": [
    "id",
    "name",
    "total_item_count"
  ],
  "properties": {
    "cover_item": {
      "type": "object",
      "description": "Featured collection cover item metadata",
      "required": [
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "description": "URL of the collection cover item"
        }
      }
    },
    "created_time": {
      "type": "string",
      "format": "date-time",
      "description": "Date that the collection was created"
    },
    "hero_item": {
      "type": "object",
      "description": "Featured collection cover item metadata",
      "required": [
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "description": "URL of the collection cover item"
        }
      }
    },
    "id": {
      "type": "string",
      "description": "Collection ID"
    },
    "items_updated_time": {
      "type": "string",
      "format": "date-time",
      "description": "Date that an item in the collection was last added or removed"
    },
    "name": {
      "type": "string",
      "description": "Name of the collection"
    },
    "share_url": {
      "type": "string",
      "description": "Unique share url for the collection"
    },
    "total_item_count": {
      "type": "integer",
      "description": "Total number of items in the collection"
    },
    "updated_time": {
      "type": "string",
      "format": "date-time",
      "description": "Date that the collection was last modified"
    }
  }
}