BUbunny
Manage Collections

Get Collection

Changed on

Returns the details of a collection. Collections can group both videos and live streams, reflected separately in VideoCount and LiveStreamCount; PreviewImageUrls only reflects the videos in the collection.

get/library/{libraryId}/collections/{collectionId}

Request

Path parameters

libraryIdinteger required

The ID of the video library.

collectionIdstring required

The unique ID of the collection.

Query parameters

includeThumbnailsboolean

If set to true, populates PreviewImageUrls with thumbnails for videos in the collection.

Response

The details of the requested collection

videoLibraryIdinteger

The video library ID that contains the collection

guidstring nullable

The unique ID of the collection

namestring nullable

The name of the collection

videoCountinteger

The number of on-demand videos in the collection. Live streams in the collection are not included in this count.

liveStreamCountinteger

The number of live streams in the collection. On-demand videos are not included in this count.

totalSizeinteger

The total storage size of all videos in the collection, in bytes.

previewVideoIdsstring nullable

Comma-separated list of video GUIDs used as preview thumbnails for the collection.

previewImageUrlsstring[] nullable

The URLs of preview images of videos in the collection

Changes

  • 83116184952fRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the optional property to the response with the status