vimeo
Module vimeo
API
Definitions
ballerinax/vimeo Ballerina library
Overview
This is a generated connector for Vimeo API v3.4 OpenAPI specification. The Vimeo API provides access to manage Vimeo platform. This includes management of videos, channels, albums, users etc.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Vimeo account
- Obtain tokens - Follow this link
Quickstart
To use the Vimeo connector in your Ballerina application, update the .bal file as follows:
Step 1: Import connector
First, import the ballerinax/vimeo module into the Ballerina project.
import ballerinax/vimeo;
Step 2: Create a new connector instance
You can now make the connection configuration using token.
You can do this step in two ways. You can use any one of this.
-
Option 1 : Configure token in ballerina file directly.
vimeo:ClientConfig clientConfig = { auth : { token : "" } }; vimeo:Client baseClient = check new Client(clientConfig);
-
Option 2 : Configure token in
Config.toml
file and configure it in ballerina file, using configurables.- Set up token in
Config.toml
as shown below.
[auth] token = "<Enter your token here>"
- Configure the client in ballerina file as shown below.
configurable http:BearerTokenConfig & readonly auth = ?; vimeo:ClientConfig clientConfig = {auth : auth}; vimeo:Client baseClient = check new Client(clientConfig);
- Set up token in
Step 3: Invoke connector operation
- You can get a specific channel information as shown below.
vimeo:Channel channel = check baseClient->getChannel(channelID);
- Use
bal run
command to compile and run the Ballerina program.
Clients
vimeo: Client
This is a generated connector for Vimeo API v3.4 OpenAPI specification. The Vimeo API provides access to manage Vimeo platform. This includes management of videos, channels, albums, users etc.
Constructor
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a Vimeo account and obtain tokens by following this guide.
init (ClientConfig clientConfig, string serviceUrl)
- clientConfig ClientConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.vimeo.com" - URL of the target service
getEndpoints
Get an API specification
Parameters
- openapi boolean? (default ()) - Return an OpenAPI specification.
getCategories
function getCategories(string? direction, decimal? page, decimal? perPage, string? sort) returns Category[]|error
Get all categories
Parameters
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results.
getCategory
Get a specific category
Parameters
- category string - The name of the category.
getCategoryChannels
function getCategoryChannels(string category, string? direction, decimal? page, decimal? perPage, string? query, string? sort) returns Channel[]|error
Get all the channels in a category
Parameters
- category string - The name of the category.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
getCategoryGroups
function getCategoryGroups(string category, string? direction, decimal? page, decimal? perPage, string? query, string? sort) returns Group[]|error
Get all the groups in a category
Parameters
- category string - The name of the category.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
getCategoryVideos
function getCategoryVideos(string category, string? direction, string? filter, boolean? filterEmbeddable, decimal? page, decimal? perPage, string? query, string? sort) returns Video[]|error
Get all the videos in a category
Parameters
- category string - The name of the category.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results. Option descriptions: *
conditional_featured
- Featured (promoted) videos
- filterEmbeddable boolean? (default ()) - Whether to filter the results by embeddable videos (
true
) or non-embeddable videos (false
). Required only if filter isembeddable
.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
checkCategoryForVideo
Check for a video in a category
getChannels
function getChannels(string? direction, string? filter, decimal? page, decimal? perPage, string? query, string? sort) returns Channel[]|error
Get all channels
Parameters
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results. Option descriptions: *
relevant
- Relevant sorting is available only for search queries.
createChannel
Create a channel
Parameters
- payload byte[] -
getChannel
Get a specific channel
Parameters
- channelId decimal - The ID of the channel.
deleteChannel
Delete a channel
Parameters
- channelId decimal - The ID of the channel.
editChannel
Edit a channel
getChannelCategories
Get all the categories in a channel
Parameters
- channelId decimal - The ID of the channel.
addChannelCategories
function addChannelCategories(decimal channelId, ChannelIdCategoriesBody payload) returns Response|error
Add a list of categories to a channel
categorizeChannel
Categorize a channel
deleteChannelCategory
Remove a category from a channel
getChannelModerators
function getChannelModerators(decimal channelId, string? direction, decimal? page, decimal? perPage, string? query, string? sort) returns User[]|error
Get all the moderators in a channel
Parameters
- channelId decimal - The ID of the channel.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
addChannelModerators
function addChannelModerators(decimal channelId, ChannelIdModeratorsBody payload) returns Response|error
Add a list of channel moderators
removeChannelModerators
Remove a list of channel moderators
Parameters
- channelId decimal - The ID of the channel.
replaceChannelModerators
function replaceChannelModerators(decimal channelId, ChannelIdModeratorsBody1 payload) returns User[]|error
Replace the moderators of a channel
getChannelModerator
Get a specific channel moderator
addChannelModerator
Add a specific channel moderator
Return Type
removeChannelModerator
Remove a specific channel moderator
getChannelPrivacyUsers
function getChannelPrivacyUsers(decimal channelId, string? direction, decimal? page, decimal? perPage) returns User[]|error
Get all the users who can view a private channel
Parameters
- channelId decimal - The ID of the channel.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
setChannelPrivacyUsers
Permit a list of users to view a private channel
setChannelPrivacyUser
Permit a specific user to view a private channel
deleteChannelPrivacyUser
Restrict a user from viewing a private channel
getChannelTags
Get all the tags that have been added to a channel
Parameters
- channelId decimal - The ID of the channel.
addTagsToChannel
Add a list of tags to a channel
checkIfChannelHasTag
Check if a tag has been added to a channel
addChannelTag
Add a specific tag to a channel
deleteTagFromChannel
Remove a tag from a channel
getChannelSubscribers
function getChannelSubscribers(decimal channelId, string filter, string? direction, decimal? page, decimal? perPage, string? query, string? sort) returns User[]|error
Get all the followers of a channel
Parameters
- channelId decimal - The ID of the channel.
- filter string - The attribute by which to filter the results.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
getChannelVideos
function getChannelVideos(decimal channelId, string? containingUri, string? direction, string? filter, boolean? filterEmbeddable, decimal? page, decimal? perPage, string? query, string? sort) returns Video[]|error
Get all the videos in a channel
Parameters
- channelId decimal - The ID of the channel.
- containingUri string? (default ()) - The page that contains the video URI.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- filterEmbeddable boolean? (default ()) - Whether to filter the results by embeddable videos (
true
) or non-embeddable videos (false
). Required only if filter isembeddable
.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
addVideosToChannel
function addVideosToChannel(decimal channelId, ChannelIdVideosBody payload) returns Response|error
Add a list of videos to a channel
removeVideosFromChannel
Remove a list of videos from a channel
Parameters
- channelId decimal - The ID of the channel.
getChannelVideo
Get a specific video in a channel
addVideoToChannel
Add a specific video to a channel
deleteVideoFromChannel
Remove a specific video from a channel
getCommentsAlt1
function getCommentsAlt1(decimal channelId, decimal videoId, string? direction, decimal? page, decimal? perPage) returns Comment[]|error
Get all the comments on a video
Parameters
- channelId decimal - The ID of the channel.
- videoId decimal - The ID of the video.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
createCommentAlt1
function createCommentAlt1(decimal channelId, decimal videoId, byte[] payload) returns Comment|error
Add a comment to a video
Parameters
- channelId decimal - The ID of the channel.
- videoId decimal - The ID of the video.
- payload byte[] -
getVideoCreditsAlt1
function getVideoCreditsAlt1(decimal channelId, decimal videoId, string? direction, decimal? page, decimal? perPage, string? query, string? sort) returns Credit[]|error
Get all the credited users in a video
Parameters
- channelId decimal - The ID of the channel.
- videoId decimal - The ID of the video.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
addVideoCreditAlt1
function addVideoCreditAlt1(decimal channelId, decimal videoId, byte[] payload) returns Credit|error
Credit a user in a video
Parameters
- channelId decimal - The ID of the channel.
- videoId decimal - The ID of the video.
- payload byte[] -
getVideoLikesAlt1
function getVideoLikesAlt1(decimal channelId, decimal videoId, string? direction, decimal? page, decimal? perPage, string? sort) returns User[]|error
Get all the users who have liked a video
Parameters
- channelId decimal - The ID of the channel.
- videoId decimal - The ID of the video.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results.
getVideoThumbnailsAlt1
function getVideoThumbnailsAlt1(decimal channelId, decimal videoId, decimal? page, decimal? perPage) returns Picture[]|error
Get all the thumbnails of a video
Parameters
- channelId decimal - The ID of the channel.
- videoId decimal - The ID of the video.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
createVideoThumbnailAlt1
function createVideoThumbnailAlt1(decimal channelId, decimal videoId, byte[] payload) returns Picture|error
Add a video thumbnail
Parameters
- channelId decimal - The ID of the channel.
- videoId decimal - The ID of the video.
- payload byte[] -
getVideoPrivacyUsersAlt1
function getVideoPrivacyUsersAlt1(decimal channelId, decimal videoId, decimal? page, decimal? perPage) returns User[]|error
Get all the users who can view a user's private videos by default
Parameters
- channelId decimal - The ID of the channel.
- videoId decimal - The ID of the video.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
addVideoPrivacyUsersAlt1
Permit a list of users to view a private video
getTextTracksAlt1
Get all the text tracks of a video
createTextTrackAlt1
function createTextTrackAlt1(decimal channelId, decimal videoId, byte[] payload) returns TextTrack|error
Add a text track to a video
Parameters
- channelId decimal - The ID of the channel.
- videoId decimal - The ID of the video.
- payload byte[] -
getContentRatings
function getContentRatings() returns ContentRating[]|error
Get all content ratings
Return Type
- ContentRating[]|error - The content ratings were returned.
getCcLicenses
function getCcLicenses() returns CreativeCommons[]|error
Get all Creative Commons licenses
Return Type
- CreativeCommons[]|error - The Creative Commons licenses were returned.
getGroups
function getGroups(string? direction, string? filter, decimal? page, decimal? perPage, string? query, string? sort) returns Group[]|error
Get all groups
Parameters
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results. Option descriptions: *
relevant
- Relevant sorting is available only for search queries.
createGroup
Create a group
Parameters
- payload byte[] -
getGroup
Get a specific group
Parameters
- groupId decimal - The ID of the group.
deleteGroup
Delete a group
Parameters
- groupId decimal - The ID of the group.
getGroupMembers
function getGroupMembers(decimal groupId, string? direction, string? filter, decimal? page, decimal? perPage, string? query, string? sort) returns User[]|error
Get all the members of a group
Parameters
- groupId decimal - The ID of the group.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
getGroupVideos
function getGroupVideos(decimal groupId, string? direction, string? filter, boolean? filterEmbeddable, decimal? page, decimal? perPage, string? query, string? sort) returns Video[]|error
Get all the videos in a group
Parameters
- groupId decimal - The ID of the group.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- filterEmbeddable boolean? (default ()) - Whether to filter the results by embeddable videos (
true
) or non-embeddable videos (false
). Required only if filter isembeddable
.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
getGroupVideo
Get a specific video in a group
addVideoToGroup
Add a video to a group
deleteVideoFromGroup
Remove a video from a group
getLanguages
Get all languages
Parameters
- filter string? (default ()) - The attribute by which to filter the results. Option descriptions: *
texttracks
- Only return text track supported languages
getUserAlt1
Get a user
editUserAlt1
Edit a user
Parameters
- payload byte[] -
getAlbumsAlt1
function getAlbumsAlt1(string? direction, decimal? page, decimal? perPage, string? query, string? sort) returns Album[]|error
Get all the albums that belong to a user
Parameters
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
createAlbumAlt1
Create an album
Parameters
- payload byte[] -
getAlbumAlt1
Get a specific album
Parameters
- albumId decimal - The ID of the album.
deleteAlbumAlt1
Delete an album
Parameters
- albumId decimal - The ID of the album.
editAlbumAlt1
Edit an album
getAlbumVideosAlt1
function getAlbumVideosAlt1(decimal albumId, string? containingUri, string? direction, string? filter, boolean? filterEmbeddable, decimal? page, string? password, decimal? perPage, string? query, string? sort, boolean? weakSearch) returns Video[]|error
Get all the videos in an album
Parameters
- albumId decimal - The ID of the album.
- containingUri string? (default ()) - The page containing the video URI.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- filterEmbeddable boolean? (default ()) - Whether to filter the results by embeddable videos (
true
) or non-embeddable videos (false
). Required only if filter isembeddable
.
- page decimal? (default ()) - The page number of the results to show.
- password string? (default ()) - The password of the album.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
- weakSearch boolean? (default ()) - Whether to include private videos in the search. Please note that a separate search service provides this functionality. The service performs a partial text search on the video's name.
replaceVideosInAlbumAlt1
function replaceVideosInAlbumAlt1(decimal albumId, AlbumIdVideosBody payload) returns Response|error
Replace all the videos in an album
getAlbumVideoAlt1
Get a specific video in an album
Parameters
- albumId decimal - The ID of the album.
- videoId decimal - The ID of the video.
- password string? (default ()) - The password of the album.
addVideoToAlbumAlt1
Add a specific video to an album
removeVideoFromAlbumAlt1
Remove a video from an album
setVideoAsAlbumThumbnailAlt1
function setVideoAsAlbumThumbnailAlt1(decimal albumId, decimal videoId, VideoIdSetAlbumThumbnailBody payload) returns Album|error
Set a video as the album thumbnail
Parameters
- albumId decimal - The ID of the album.
- videoId decimal - The ID of the video.
- payload VideoIdSetAlbumThumbnailBody -
getAppearancesAlt1
function getAppearancesAlt1(string? direction, string? filter, boolean? filterEmbeddable, decimal? page, decimal? perPage, string? query, string? sort) returns Video[]|error
Get all the videos in which a user appears
Parameters
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- filterEmbeddable boolean? (default ()) - Whether to filter the results by embeddable videos (
true
) or non-embeddable videos (false
). Required only if filter isembeddable
.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
getCategorySubscriptionsAlt1
function getCategorySubscriptionsAlt1(string? direction, decimal? page, decimal? perPage, string? sort) returns Category[]|error
Get all the categories that a user follows
Parameters
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results.
checkIfUserSubscribedToCategoryAlt1
Check if a user follows a category
Parameters
- category string - The name of the category.
subscribeToCategoryAlt1
Subscribe a user to a single category
Parameters
- category decimal - The name of the category.
unsubscribeFromCategoryAlt1
Unsubscribe a user from a category
Parameters
- category string - The name of the category.
getChannelSubscriptionsAlt1
function getChannelSubscriptionsAlt1(string? direction, string? filter, decimal? page, decimal? perPage, string? query, string? sort) returns Channel[]|error
Get all the channels to which a user subscribes
Parameters
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
checkIfUserSubscribedToChannelAlt1
Check if a user follows a channel
Parameters
- channelId decimal - The ID of the channel.
subscribeToChannelAlt1
Subscribe a user to a specific channel
Parameters
- channelId decimal - The ID of the channel.
unsubscribeFromChannelAlt1
Unsubscribe a user from a specific channel
Parameters
- channelId decimal - The ID of the channel.
getCustomLogosAlt1
Get all the custom logos that belong to a user
createCustomLogoAlt1
Add a custom logo
getCustomLogoAlt1
Get a specific custom logo
Parameters
- logoId decimal - The ID of the custom logo.
getFeedAlt1
function getFeedAlt1(string? offset, decimal? page, decimal? perPage, string? 'type) returns Activity31[]|error
Get all videos in a user's feed
Parameters
- offset string? (default ()) - Necessary for proper pagination. You shouldn't provide this value yourself, and instead use the pagination links in the feed response. Please see our pagination documentation for more information.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- 'type string? (default ()) - The feed type.
Return Type
- Activity31[]|error - The videos were returned.
getFollowersAlt1
function getFollowersAlt1(string? direction, decimal? page, decimal? perPage, string? query, string? sort) returns User[]|error
Get all the followers of a user
Parameters
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
getUserFollowingAlt1
function getUserFollowingAlt1(string? direction, string? filter, decimal? page, decimal? perPage, string? query, string? sort) returns User[]|error
Get all the users that a user is following
Parameters
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
followUsersAlt1
function followUsersAlt1(MeFollowingBody payload) returns Response|error
Follow a list of users
Parameters
- payload MeFollowingBody -
checkIfUserIsFollowingAlt1
Check if a user is following another user
Parameters
- followUserId decimal - The ID of the following user.
followUserAlt1
Follow a specific user
Parameters
- followUserId decimal - The ID of the following user.
unfollowUserAlt1
Unfollow a user
Parameters
- followUserId decimal - The ID of the following user.
getUserGroupsAlt1
function getUserGroupsAlt1(string? direction, string? filter, decimal? page, decimal? perPage, string? query, string? sort) returns Group[]|error
Get all the groups that a user has joined
Parameters
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
checkIfUserJoinedGroupAlt1
Check if a user has joined a group
Parameters
- groupId decimal - The ID of the group.
joinGroupAlt1
Add a user to a group
Parameters
- groupId decimal - The ID of the group.
leaveGroupAlt1
Remove a user from a group
Parameters
- groupId decimal - The ID of the group.
getLikesAlt1
function getLikesAlt1(string? filter, boolean? filterEmbeddable, decimal? page, decimal? perPage, string? query, string? sort) returns Video[]|error
Get all the videos that a user has liked
Parameters
- filter string? (default ()) - The attribute by which to filter the results.
- filterEmbeddable boolean? (default ()) - Whether to filter the results by embeddable videos (
true
) or non-embeddable videos (false
). Required only if filter isembeddable
.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
checkIfUserLikedVideoAlt1
Check if a user has liked a video
Parameters
- videoId decimal - The ID of the video.
likeVideoAlt1
Cause a user to like a video
Parameters
- videoId decimal - The ID of the video.
unlikeVideoAlt1
Cause a user to unlike a video
Parameters
- videoId decimal - The ID of the video.
getUserVodsAlt1
function getUserVodsAlt1(string? direction, string? filter, decimal? page, decimal? perPage, string? sort) returns OnDemandPage[]|error
Get all the On Demand pages of a user
Parameters
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The type of On Demand pages to return.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results.
Return Type
- OnDemandPage[]|error - The On Demand pages were returned.
createVodAlt1
function createVodAlt1(OndemandPagesBody payload) returns OnDemandPage|error
Create an On Demand page
Parameters
- payload OndemandPagesBody -
Return Type
- OnDemandPage|error - The On Demand page was created.
getVodPurchases
function getVodPurchases(string? direction, string? filter, decimal? page, decimal? perPage, string? sort) returns OnDemandPage[]|error
Get all the On Demand purchases and rentals that a user has made
Parameters
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The type of On Demand videos to show. Option descriptions: *
important
- Will show all pages which are about to expire.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results.
Return Type
- OnDemandPage[]|error - The purchases and rentals were returned.
checkIfVodWasPurchasedAlt1
function checkIfVodWasPurchasedAlt1(decimal ondemandId) returns OnDemandPage|error
Check if a user has made a purchase or rental from an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
Return Type
- OnDemandPage|error - You have purchased the On Demand page.
getPicturesAlt1
Get all the pictures that belong to a user
Parameters
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
createPictureAlt1
Add a user picture
getPictureAlt1
Get a specific user picture
Parameters
- portraitsetId decimal - The ID of the picture.
deletePictureAlt1
Delete a user picture
Parameters
- portraitsetId decimal - The ID of the picture.
editPictureAlt1
Edit a user picture
getPortfoliosAlt1
function getPortfoliosAlt1(string? direction, decimal? page, decimal? perPage, string? query, string? sort) returns Portfolio[]|error
Get all the portfolios that belong to a user
Parameters
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
getPortfolioAlt1
Get a specific portfolio
Parameters
- portfolioId decimal - The ID of the portfolio.
getPortfolioVideosAlt1
function getPortfolioVideosAlt1(decimal portfolioId, string? containingUri, string? filter, boolean? filterEmbeddable, decimal? page, decimal? perPage, string? sort) returns Video[]|error
Get all the videos in a portfolio
Parameters
- portfolioId decimal - The ID of the portfolio.
- containingUri string? (default ()) - The page that contains the video URI.
- filter string? (default ()) - The attribute by which to filter the results.
- filterEmbeddable boolean? (default ()) - Whether to filter the results by embeddable videos (
true
) or non-embeddable videos (false
). Required only if filter isembeddable
.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results. Option descriptions: *
default
- This will sort to the default sort set on the portfolio.
getPortfolioVideoAlt1
Get a specific video in a portfolio
addVideoToPortfolioAlt1
Add a video to a portfolio
deleteVideoFromPortfolioAlt1
Remove a video from a portfolio
getEmbedPresetsAlt1
Get all the embed presets that a user has created
Parameters
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
getEmbedPresetAlt1
Get a specific embed preset
Parameters
- presetId decimal - The ID of the preset.
editEmbedPresetAlt1
Edit an embed preset
getEmbedPresetVideosAlt1
function getEmbedPresetVideosAlt1(decimal presetId, decimal? page, decimal? perPage) returns Video[]|error
Get all the videos that have been added to an embed preset
Parameters
- presetId decimal - The ID of the preset.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
getProjectsAlt1
function getProjectsAlt1(string? direction, decimal? page, decimal? perPage, string? sort) returns Project[]|error
Get all the projects that belong to a user
Parameters
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results.
createProjectAlt1
function createProjectAlt1(MeProjectsBody payload) returns Project|error
Create a project
Parameters
- payload MeProjectsBody -
getProjectAlt1
Get a specific project
Parameters
- projectId decimal - The ID of the project.
deleteProjectAlt1
Delete a project
Parameters
- projectId decimal - The ID of the project.
- shouldDeleteClips boolean? (default ()) - Whether to delete all the videos in the project along with the project itself.
editProjectAlt1
function editProjectAlt1(decimal projectId, ProjectsProjectIdBody payload) returns Project|error
Edit a project
getProjectVideosAlt1
function getProjectVideosAlt1(decimal projectId, string? direction, decimal? page, decimal? perPage, string? sort) returns Video[]|error
Get all the videos in a project
Parameters
- projectId decimal - The ID of the project.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results.
addVideosToProjectAlt1
Add a list of videos to a project
Parameters
- projectId decimal - The ID of the project.
- uris string - A comma-separated list of video URIs to add.
removeVideosFromProjectAlt1
function removeVideosFromProjectAlt1(decimal projectId, string uris, boolean? shouldDeleteClips) returns Response|error
Remove a list of videos from a project
Parameters
- projectId decimal - The ID of the project.
- uris string - A comma-separated list of the video URIs to remove.
- shouldDeleteClips boolean? (default ()) - Whether to delete the videos when removing them from the project.
addVideoToProjectAlt1
Add a specific video to a project
removeVideoFromProjectAlt1
Remove a specific video from a project
getVideosAlt1
function getVideosAlt1(string? containingUri, string? direction, string? filter, boolean? filterEmbeddable, boolean? filterPlayable, decimal? page, decimal? perPage, string? query, string? sort) returns Video[]|error
Get all the videos that a user has uploaded
Parameters
- containingUri string? (default ()) - The page that contains the video URI. Only available when not paired with
query
.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- filterEmbeddable boolean? (default ()) - Whether to filter the results by embeddable videos (
true
) or non-embeddable videos (false
). Required only if filter isembeddable
.
- filterPlayable boolean? (default ()) - Whether to filter by all playable videos or by all videos that are not playable.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
uploadVideoAlt1
Upload a video
Parameters
- payload byte[] -
checkIfUserOwnsVideoAlt1
Check if a user owns a video
Parameters
- videoId decimal - The ID of the video.
getWatchHistory
Get all the videos that a user has watched
Parameters
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
deleteWatchHistory
Delete a user's watch history
deleteFromWatchHistory
Delete a specific video from a user's watch history
Parameters
- videoId decimal - The ID of the video.
getWatchLaterQueueAlt1
function getWatchLaterQueueAlt1(string? direction, string? filter, boolean? filterEmbeddable, decimal? page, decimal? perPage, string? query, string? sort) returns Video[]|error
Get all the videos in a user's Watch Later queue
Parameters
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- filterEmbeddable boolean? (default ()) - Whether to filter the results by embeddable videos (
true
) or non-embeddable videos (false
). Required only if filter isembeddable
.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
checkWatchLaterQueueAlt1
Check if a user has added a specific video to their Watch Later queue
Parameters
- videoId decimal - The ID of the video.
addVideoToWatchLaterAlt1
Add a video to a user's Watch Later queue
Parameters
- videoId decimal - The ID of the video.
deleteVideoFromWatchLaterAlt1
Remove a video from a user's Watch Later queue
Parameters
- videoId decimal - The ID of the video.
exchangeAuthCode
Exchange an authorization code for an access token
Parameters
- payload byte[] -
clientAuth
Authorize a client with OAuth
Parameters
- payload byte[] -
convertAccessToken
Convert OAuth 1 access tokens to OAuth 2 access tokens
Parameters
- payload byte[] -
verifyToken
Verify an OAuth 2 token
getVodGenres
function getVodGenres() returns OnDemandGenre[]|error
Get all On Demand genres
Return Type
- OnDemandGenre[]|error - The On Demand genres were returned.
getVodGenre
function getVodGenre(string genreId) returns OnDemandGenre|error
Get a specific On Demand genre
Parameters
- genreId string - The ID of the genre.
Return Type
- OnDemandGenre|error - The On Demand genre was returned.
getGenreVods
function getGenreVods(string genreId, string? direction, string? filter, decimal? page, decimal? perPage, string? query, string? sort) returns OnDemandPage[]|error
Get all the On Demand pages in a genre
Parameters
- genreId string - The ID of the genre.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
Return Type
- OnDemandPage[]|error - The On Demand pages were returned.
getGenreVod
function getGenreVod(string genreId, decimal ondemandId) returns OnDemandPage|error
Get a specific On Demand page in a genre
Return Type
- OnDemandPage|error - The On Demand page belongs to the genre.
getVod
function getVod(decimal ondemandId) returns OnDemandPage|error
Get a specific On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
Return Type
- OnDemandPage|error - The On Demand page was returned.
deleteVodDraft
Delete a draft of an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
editVod
function editVod(decimal ondemandId, byte[] payload) returns OnDemandPage|error
Edit an On Demand page
Return Type
- OnDemandPage|error - The On Demand page was edited.
getVodBackgrounds
function getVodBackgrounds(decimal ondemandId, decimal? page, decimal? perPage) returns Picture[]|error
Get all the backgrounds of an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
createVodBackground
Add a background to an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
getVodBackground
Get a specific background of an On Demand page
Parameters
- backgroundId decimal - The ID of the background.
- ondemandId decimal - The ID of the On Demand.
deleteVodBackground
Remove a background from an On Demand page
Parameters
- backgroundId decimal - The ID of the background.
- ondemandId decimal - The ID of the On Demand.
editVodBackground
function editVodBackground(decimal backgroundId, decimal ondemandId, byte[] payload) returns Picture|error
Edit a background of an On Demand page
Parameters
- backgroundId decimal - The ID of the background.
- ondemandId decimal - The ID of the On Demand.
- payload byte[] -
getVodGenresByOndemandId
function getVodGenresByOndemandId(decimal ondemandId) returns OnDemandGenre[]|error
Get all the genres of an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
Return Type
- OnDemandGenre[]|error - The genres were returned.
getVodGenreByOndemandId
function getVodGenreByOndemandId(string genreId, decimal ondemandId) returns OnDemandGenre|error
Check whether an On Demand page belongs to a genre
Return Type
- OnDemandGenre|error - The On Demand page's genre was returned.
addVodGenre
function addVodGenre(string genreId, decimal ondemandId) returns OnDemandGenre|error
Add a genre to an On Demand page
Return Type
- OnDemandGenre|error - The genre was added.
deleteVodGenre
Remove a genre from an On Demand page
getVodLikes
function getVodLikes(decimal ondemandId, string? direction, string? filter, decimal? page, decimal? perPage, string? sort) returns User[]|error
Get all the users who have liked a video on an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand page.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results.
getVodPosters
Get all the posters of an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
addVodPoster
Add a poster to an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
getVodPoster
Get a specific poster of an On Demand page
editVodPoster
Edit a poster of an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
- posterId decimal - The ID of the picture.
- payload byte[] -
getVodPromotions
function getVodPromotions(decimal ondemandId, string filter, decimal? page, decimal? perPage) returns OnDemandPromotion|error
Get all the promotions on an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
- filter string - The filter to apply to the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
Return Type
- OnDemandPromotion|error - The promotions were returned.
createVodPromotion
function createVodPromotion(decimal ondemandId, byte[] payload) returns OnDemandPromotion|error
Add a promotion to an On Demand page
Return Type
- OnDemandPromotion|error - The promotion was added.
getVodPromotion
function getVodPromotion(decimal ondemandId, decimal promotionId) returns OnDemandPromotion|error
Get a specific promotion on an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
- promotionId decimal - The ID of the promotion.
Return Type
- OnDemandPromotion|error - The promotion was returned.
deleteVodPromotion
Remove a promotion from an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
- promotionId decimal - The ID of the promotion.
getVodPromotionCodes
function getVodPromotionCodes(decimal ondemandId, decimal promotionId, decimal? page, decimal? perPage) returns OnDemandPromotionCode|error
Get all the codes of a promotion on an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
- promotionId decimal - The ID of the promotion.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
Return Type
- OnDemandPromotionCode|error - The codes were returned.
getVodRegions
function getVodRegions(decimal ondemandId) returns OnDemandRegion[]|error
Get all the regions of an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
Return Type
- OnDemandRegion[]|error - The regions were returned.
setVodRegions
function setVodRegions(decimal ondemandId, byte[] payload) returns OnDemandRegion|error
Add a list of regions to an On Demand page
Return Type
- OnDemandRegion|error - The list of regions was set.
deleteVodRegions
function deleteVodRegions(decimal ondemandId) returns OnDemandRegion[]|error
Remove a list of regions from an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
Return Type
- OnDemandRegion[]|error - The On Demand regions were deleted.
getVodRegion
function getVodRegion(string country, decimal ondemandId) returns OnDemandRegion|error
Get a specific region of an On Demand page
Return Type
- OnDemandRegion|error - The On Demand page's region was returned.
addVodRegion
function addVodRegion(string country, decimal ondemandId) returns OnDemandRegion|error
Add a specific region to an On Demand page
Return Type
- OnDemandRegion|error - The region was added.
deleteVodRegion
Remove a specific region from an On Demand page
getVodSeasons
function getVodSeasons(decimal ondemandId, string? direction, string? filter, decimal? page, decimal? perPage, string? sort) returns OnDemandSeason[]|error
Get all the seasons on an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results.
Return Type
- OnDemandSeason[]|error - The seasons were returned.
getVodSeason
function getVodSeason(decimal ondemandId, decimal seasonId) returns OnDemandSeason|error
Get a specific season on an On Demand page
Return Type
- OnDemandSeason|error - The season was returned.
getVodSeasonVideos
function getVodSeasonVideos(decimal ondemandId, decimal seasonId, string? filter, decimal? page, decimal? perPage, string? sort) returns Video[]|error
Get all the videos in a season on an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
- seasonId decimal - The ID of the season.
- filter string? (default ()) - The attribute by which to filter the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results.
getVodVideos
function getVodVideos(decimal ondemandId, string? direction, string? filter, decimal? page, decimal? perPage, string? sort) returns Video[]|error
Get all the videos on an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results.
getVodVideo
Get a specific video on an On Demand page
addVideoToVod
function addVideoToVod(decimal ondemandId, decimal videoId, byte[] payload) returns OnDemandVideo|error
Add a video to an On Demand page
Parameters
- ondemandId decimal - The ID of the On Demand.
- videoId decimal - The ID of the video.
- payload byte[] -
Return Type
- OnDemandVideo|error - The video was added.
deleteVideoFromVod
Remove a video from an On Demand page
getRegions
function getRegions() returns OnDemandRegion[]|error
Get all the On Demand regions
Return Type
- OnDemandRegion[]|error - The On Demand regions were returned.
getRegion
function getRegion(string country) returns OnDemandRegion|error
Get a specific On Demand region
Parameters
- country string - The country code.
Return Type
- OnDemandRegion|error - The On Demand region was returned.
getTag
Get a specific tag
Parameters
- word string - The tag to return.
getVideosWithTag
function getVideosWithTag(string word, string? direction, decimal? page, decimal? perPage, string? sort) returns Video[]|error
Get all the videos with a specific tag
Parameters
- word string - The tag word.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results.
deleteToken
Revoke the current access token
searchUsers
function searchUsers(string? direction, decimal? page, decimal? perPage, string? query, string? sort) returns User[]|error
Search for users
Parameters
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
getUser
Get a user
Parameters
- userId decimal - The ID of the user.
editUser
Edit a user
getAlbums
function getAlbums(decimal userId, string? direction, decimal? page, decimal? perPage, string? query, string? sort) returns Album[]|error
Get all the albums that belong to a user
Parameters
- userId decimal - The ID of the user.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
createAlbum
Create an album
getAlbum
Get a specific album
deleteAlbum
Delete an album
editAlbum
Edit an album
Parameters
- albumId decimal - The ID of the album.
- userId decimal - The ID of the user.
- payload byte[] -
getAlbumCustomThumbs
function getAlbumCustomThumbs(decimal albumId, decimal userId, decimal? page, decimal? perPage) returns Picture[]|error
Get all the custom upload thumbnails of an album
Parameters
- albumId decimal - The ID of the album.
- userId decimal - The ID of the user.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
createAlbumCustomThumb
Add a custom uploaded thumbnail
getAlbumCustomThumbnail
function getAlbumCustomThumbnail(decimal albumId, decimal thumbnailId, decimal userId) returns Picture|error
Get a specific custom uploaded album thumbnail
Parameters
- albumId decimal - The ID of the album.
- thumbnailId decimal - The ID of the custom thumbnail.
- userId decimal - The ID of the user.
deleteAlbumCustomThumbnail
function deleteAlbumCustomThumbnail(decimal albumId, decimal thumbnailId, decimal userId) returns Response|error
Remove a custom uploaded album thumbnail
Parameters
- albumId decimal - The ID of the album.
- thumbnailId decimal - The ID of the custom thumbnail.
- userId decimal - The ID of the user.
replaceAlbumCustomThumb
function replaceAlbumCustomThumb(decimal albumId, decimal thumbnailId, decimal userId, byte[] payload) returns Picture|error
Replace a custom uploaded album thumbnail
Parameters
- albumId decimal - The ID of the album.
- thumbnailId decimal - The ID of the custom thumbnail.
- userId decimal - The ID of the user.
- payload byte[] -
getAlbumLogos
function getAlbumLogos(decimal albumId, decimal userId, decimal? page, decimal? perPage) returns Picture[]|error
Get all the custom logos of an album
Parameters
- albumId decimal - The ID of the album.
- userId decimal - The ID of the user.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
createAlbumLogo
Add a custom album logo
getAlbumLogo
Get a specific custom album logo
Parameters
- albumId decimal - The ID of the album.
- logoId decimal - The ID of the custom logo.
- userId decimal - The ID of the user.
deleteAlbumLogo
Remove a custom album logo
Parameters
- albumId decimal - The ID of the album.
- logoId decimal - The ID of the custom logo.
- userId decimal - The ID of the user.
replaceAlbumLogo
function replaceAlbumLogo(decimal albumId, decimal logoId, decimal userId, byte[] payload) returns Picture|error
Replace a custom album logo
Parameters
- albumId decimal - The ID of the album.
- logoId decimal - The ID of the custom logo.
- userId decimal - The ID of the user.
- payload byte[] -
getAlbumVideos
function getAlbumVideos(decimal albumId, decimal userId, string? containingUri, string? direction, string? filter, boolean? filterEmbeddable, decimal? page, string? password, decimal? perPage, string? query, string? sort, boolean? weakSearch) returns Video[]|error
Get all the videos in an album
Parameters
- albumId decimal - The ID of the album.
- userId decimal - The ID of the user.
- containingUri string? (default ()) - The page containing the video URI.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- filterEmbeddable boolean? (default ()) - Whether to filter the results by embeddable videos (
true
) or non-embeddable videos (false
). Required only if filter isembeddable
.
- page decimal? (default ()) - The page number of the results to show.
- password string? (default ()) - The password of the album.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
- weakSearch boolean? (default ()) - Whether to include private videos in the search. Please note that a separate search service provides this functionality. The service performs a partial text search on the video's name.
replaceVideosInAlbum
function replaceVideosInAlbum(decimal albumId, decimal userId, AlbumIdVideosBody1 payload) returns Response|error
Replace all the videos in an album
Parameters
- albumId decimal - The ID of the album.
- userId decimal - The ID of the user.
- payload AlbumIdVideosBody1 -
getAlbumVideo
function getAlbumVideo(decimal albumId, decimal userId, decimal videoId, string? password) returns Video|error
Get a specific video in an album
Parameters
- albumId decimal - The ID of the album.
- userId decimal - The ID of the user.
- videoId decimal - The ID of the video.
- password string? (default ()) - The password of the album.
addVideoToAlbum
Add a specific video to an album
Parameters
- albumId decimal - The ID of the album.
- userId decimal - The ID of the user.
- videoId decimal - The ID of the video.
removeVideoFromAlbum
function removeVideoFromAlbum(decimal albumId, decimal userId, decimal videoId) returns Response|error
Remove a video from an album
Parameters
- albumId decimal - The ID of the album.
- userId decimal - The ID of the user.
- videoId decimal - The ID of the video.
setVideoAsAlbumThumbnail
function setVideoAsAlbumThumbnail(decimal albumId, decimal userId, decimal videoId, VideoIdSetAlbumThumbnailBody1 payload) returns Album|error
Set a video as the album thumbnail
Parameters
- albumId decimal - The ID of the album.
- userId decimal - The ID of the user.
- videoId decimal - The ID of the video.
- payload VideoIdSetAlbumThumbnailBody1 -
getAppearances
function getAppearances(decimal userId, string? direction, string? filter, boolean? filterEmbeddable, decimal? page, decimal? perPage, string? query, string? sort) returns Video[]|error
Get all the videos in which a user appears
Parameters
- userId decimal - The ID of the user.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- filterEmbeddable boolean? (default ()) - Whether to filter the results by embeddable videos (
true
) or non-embeddable videos (false
). Required only if filter isembeddable
.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
getCategorySubscriptions
function getCategorySubscriptions(decimal userId, string? direction, decimal? page, decimal? perPage, string? sort) returns Category[]|error
Get all the categories that a user follows
Parameters
- userId decimal - The ID of the user.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results.
checkIfUserSubscribedToCategory
Check if a user follows a category
subscribeToCategory
Subscribe a user to a single category
unsubscribeFromCategory
Unsubscribe a user from a category
getChannelSubscriptions
function getChannelSubscriptions(decimal userId, string? direction, string? filter, decimal? page, decimal? perPage, string? query, string? sort) returns Channel[]|error
Get all the channels to which a user subscribes
Parameters
- userId decimal - The ID of the user.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
checkIfUserSubscribedToChannel
Check if a user follows a channel
subscribeToChannel
Subscribe a user to a specific channel
unsubscribeFromChannel
Unsubscribe a user from a specific channel
getCustomLogos
Get all the custom logos that belong to a user
Parameters
- userId decimal - The ID of the user.
createCustomLogo
Add a custom logo
Parameters
- userId decimal - The ID of the user.
getCustomLogo
Get a specific custom logo
getFeed
function getFeed(decimal userId, string? offset, decimal? page, decimal? perPage, string? 'type) returns Activity31[]|error
Get all videos in a user's feed
Parameters
- userId decimal - The ID of the user.
- offset string? (default ()) - Necessary for proper pagination. You shouldn't provide this value yourself, and instead use the pagination links in the feed response. Please see our pagination documentation for more information.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- 'type string? (default ()) - The feed type.
Return Type
- Activity31[]|error - The videos were returned.
getFollowers
function getFollowers(decimal userId, string? direction, decimal? page, decimal? perPage, string? query, string? sort) returns User[]|error
Get all the followers of a user
Parameters
- userId decimal - The ID of the user.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
getUserFollowing
function getUserFollowing(decimal userId, string? direction, string? filter, decimal? page, decimal? perPage, string? query, string? sort) returns User[]|error
Get all the users that a user is following
Parameters
- userId decimal - The ID of the user.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
followUsers
function followUsers(decimal userId, UserIdFollowingBody payload) returns Response|error
Follow a list of users
checkIfUserIsFollowing
Check if a user is following another user
followUser
Follow a specific user
unfollowUser
Unfollow a user
getUserGroups
function getUserGroups(decimal userId, string? direction, string? filter, decimal? page, decimal? perPage, string? query, string? sort) returns Group[]|error
Get all the groups that a user has joined
Parameters
- userId decimal - The ID of the user.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
checkIfUserJoinedGroup
Check if a user has joined a group
joinGroup
Add a user to a group
leaveGroup
Remove a user from a group
getLikes
function getLikes(decimal userId, string? filter, boolean? filterEmbeddable, decimal? page, decimal? perPage, string? query, string? sort) returns Video[]|error
Get all the videos that a user has liked
Parameters
- userId decimal - The ID of the user.
- filter string? (default ()) - The attribute by which to filter the results.
- filterEmbeddable boolean? (default ()) - Whether to filter the results by embeddable videos (
true
) or non-embeddable videos (false
). Required only if filter isembeddable
.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
checkIfUserLikedVideo
Check if a user has liked a video
likeVideo
Cause a user to like a video
unlikeVideo
Cause a user to unlike a video
getUserVods
function getUserVods(decimal userId, string? direction, string? filter, decimal? page, decimal? perPage, string? sort) returns OnDemandPage[]|error
Get all the On Demand pages of a user
Parameters
- userId decimal - The ID of the user.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The type of On Demand pages to return.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results.
Return Type
- OnDemandPage[]|error - The On Demand pages were returned.
createVod
function createVod(decimal userId, OndemandPagesBody1 payload) returns OnDemandPage|error
Create an On Demand page
Return Type
- OnDemandPage|error - The On Demand page was created.
checkIfVodWasPurchased
function checkIfVodWasPurchased(decimal userId) returns OnDemandPage|error
Check if a user has made a purchase or rental from an On Demand page
Parameters
- userId decimal - The ID of the user.
Return Type
- OnDemandPage|error - You have purchased the On Demand page.
getPictures
Get all the pictures that belong to a user
Parameters
- userId decimal - The ID of the user.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
createPicture
Add a user picture
Parameters
- userId decimal - The ID of the user.
getPicture
Get a specific user picture
deletePicture
Delete a user picture
editPicture
Edit a user picture
Parameters
- portraitsetId decimal - The ID of the picture.
- userId decimal - The ID of the user.
- payload byte[] -
getPortfolios
function getPortfolios(decimal userId, string? direction, decimal? page, decimal? perPage, string? query, string? sort) returns Portfolio[]|error
Get all the portfolios that belong to a user
Parameters
- userId decimal - The ID of the user.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
getPortfolio
Get a specific portfolio
getPortfolioVideos
function getPortfolioVideos(decimal portfolioId, decimal userId, string? containingUri, string? filter, boolean? filterEmbeddable, decimal? page, decimal? perPage, string? sort) returns Video[]|error
Get all the videos in a portfolio
Parameters
- portfolioId decimal - The ID of the portfolio.
- userId decimal - The ID of the user.
- containingUri string? (default ()) - The page that contains the video URI.
- filter string? (default ()) - The attribute by which to filter the results.
- filterEmbeddable boolean? (default ()) - Whether to filter the results by embeddable videos (
true
) or non-embeddable videos (false
). Required only if filter isembeddable
.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results. Option descriptions: *
default
- This will sort to the default sort set on the portfolio.
getPortfolioVideo
function getPortfolioVideo(decimal portfolioId, decimal userId, decimal videoId) returns Video|error
Get a specific video in a portfolio
Parameters
- portfolioId decimal - The ID of the portfolio.
- userId decimal - The ID of the user.
- videoId decimal - The ID of the video.
addVideoToPortfolio
function addVideoToPortfolio(decimal portfolioId, decimal userId, decimal videoId) returns Response|error
Add a video to a portfolio
Parameters
- portfolioId decimal - The ID of the portfolio.
- userId decimal - The ID of the user.
- videoId decimal - The ID of the video.
deleteVideoFromPortfolio
function deleteVideoFromPortfolio(decimal portfolioId, decimal userId, decimal videoId) returns Response|error
Remove a video from a portfolio
Parameters
- portfolioId decimal - The ID of the portfolio.
- userId decimal - The ID of the user.
- videoId decimal - The ID of the video.
getEmbedPresets
Get all the embed presets that a user has created
Parameters
- userId decimal - The ID of the user.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
getEmbedPreset
Get a specific embed preset
editEmbedPreset
Edit an embed preset
Parameters
- presetId decimal - The ID of the preset.
- userId decimal - The ID of the user.
- payload byte[] -
getEmbedPresetVideos
function getEmbedPresetVideos(decimal presetId, decimal userId, decimal? page, decimal? perPage) returns Video[]|error
Get all the videos that have been added to an embed preset
Parameters
- presetId decimal - The ID of the preset.
- userId decimal - The ID of the user.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
getProjects
function getProjects(decimal userId, string? direction, decimal? page, decimal? perPage, string? sort) returns Project[]|error
Get all the projects that belong to a user
Parameters
- userId decimal - The ID of the user.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results.
createProject
function createProject(decimal userId, UserIdProjectsBody payload) returns Project|error
Create a project
getProject
Get a specific project
deleteProject
function deleteProject(decimal projectId, decimal userId, boolean? shouldDeleteClips) returns Response|error
Delete a project
Parameters
- projectId decimal - The ID of the project.
- userId decimal - The ID of the user.
- shouldDeleteClips boolean? (default ()) - Whether to delete all the videos in the project along with the project itself.
editProject
function editProject(decimal projectId, decimal userId, ProjectsProjectIdBody1 payload) returns Project|error
Edit a project
Parameters
- projectId decimal - The ID of the project.
- userId decimal - The ID of the user.
- payload ProjectsProjectIdBody1 -
getProjectVideos
function getProjectVideos(decimal projectId, decimal userId, string? direction, decimal? page, decimal? perPage, string? sort) returns Video[]|error
Get all the videos in a project
Parameters
- projectId decimal - The ID of the project.
- userId decimal - The ID of the user.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results.
addVideosToProject
Add a list of videos to a project
Parameters
- projectId decimal - The ID of the project.
- userId decimal - The ID of the user.
- uris string - A comma-separated list of video URIs to add.
removeVideosFromProject
function removeVideosFromProject(decimal projectId, decimal userId, string uris, boolean? shouldDeleteClips) returns Response|error
Remove a list of videos from a project
Parameters
- projectId decimal - The ID of the project.
- userId decimal - The ID of the user.
- uris string - A comma-separated list of the video URIs to remove.
- shouldDeleteClips boolean? (default ()) - Whether to delete the videos when removing them from the project.
addVideoToProject
function addVideoToProject(decimal projectId, decimal userId, decimal videoId) returns Response|error
Add a specific video to a project
Parameters
- projectId decimal - The ID of the project.
- userId decimal - The ID of the user.
- videoId decimal - The ID of the video.
removeVideoFromProject
function removeVideoFromProject(decimal projectId, decimal userId, decimal videoId) returns Response|error
Remove a specific video from a project
Parameters
- projectId decimal - The ID of the project.
- userId decimal - The ID of the user.
- videoId decimal - The ID of the video.
getUploadAttempt
function getUploadAttempt(decimal upload, decimal userId) returns UploadAttempt|error
Get a user's upload attempt
Return Type
- UploadAttempt|error - The upload attempt was returned.
completeStreamingUpload
function completeStreamingUpload(decimal upload, decimal userId, string signature, decimal videoFileId) returns Response|error
Complete a user's streaming upload
Parameters
- upload decimal - The ID of the upload attempt.
- userId decimal - The ID of the user.
- signature string - The crypto signature of the completed upload.
- videoFileId decimal - The ID of the uploaded file.
getVideos
function getVideos(decimal userId, string? containingUri, string? direction, string? filter, boolean? filterEmbeddable, boolean? filterPlayable, decimal? page, decimal? perPage, string? query, string? sort) returns Video[]|error
Get all the videos that a user has uploaded
Parameters
- userId decimal - The ID of the user.
- containingUri string? (default ()) - The page that contains the video URI. Only available when not paired with
query
.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- filterEmbeddable boolean? (default ()) - Whether to filter the results by embeddable videos (
true
) or non-embeddable videos (false
). Required only if filter isembeddable
.
- filterPlayable boolean? (default ()) - Whether to filter by all playable videos or by all videos that are not playable.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
uploadVideo
Upload a video
checkIfUserOwnsVideo
Check if a user owns a video
getWatchLaterQueue
function getWatchLaterQueue(decimal userId, string? direction, string? filter, boolean? filterEmbeddable, decimal? page, decimal? perPage, string? query, string? sort) returns Video[]|error
Get all the videos in a user's Watch Later queue
Parameters
- userId decimal - The ID of the user.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
- filterEmbeddable boolean? (default ()) - Whether to filter the results by embeddable videos (
true
) or non-embeddable videos (false
). Required only if filter isembeddable
.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
checkWatchLaterQueue
Check if a user has added a specific video to their Watch Later queue
addVideoToWatchLater
Add a video to a user's Watch Later queue
deleteVideoFromWatchLater
Remove a video from a user's Watch Later queue
searchVideos
function searchVideos(string query, string? direction, string? filter, string? links, decimal? page, decimal? perPage, string? sort, string? uris) returns Video[]|error
Search for videos
Parameters
- query string - Search query.
- direction string? (default ()) - The sort direction of the results.
- filter string? (default ()) - The attribute by which to filter the results.
CC
and related filters target videos with the corresponding Creative Commons licenses. For more information, see our Creative Commons page.
- links string? (default ()) - A comma-separated list of video URLs to find.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results.
- uris string? (default ()) - The comma-separated list of videos to find.
getVideo
Get a specific video
Parameters
- videoId decimal - The ID of the video.
deleteVideo
Delete a video
Parameters
- videoId decimal - The ID of the video.
editVideo
Edit a video
getAvailableVideoChannels
Get all the channels to which a user can add or remove a specific video
Parameters
- videoId decimal - The ID of the video.
getVideoCategories
Get all the categories to which a video belongs
Parameters
- videoId decimal - The ID of the video.
suggestVideoCategory
Suggest categories for a video
getComments
function getComments(decimal videoId, string? direction, decimal? page, decimal? perPage) returns Comment[]|error
Get all the comments on a video
Parameters
- videoId decimal - The ID of the video.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
createComment
Add a comment to a video
getComment
Get a specific video comment
deleteComment
Delete a video comment
editComment
Edit a video comment
Parameters
- commentId decimal - The ID of the comment.
- videoId decimal - The ID of the video.
- payload byte[] -
getCommentReplies
function getCommentReplies(decimal commentId, decimal videoId, decimal? page, decimal? perPage) returns Comment[]|error
Get all the replies to a video comment
Parameters
- commentId decimal - The ID of the comment.
- videoId decimal - The ID of the video.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
createCommentReply
function createCommentReply(decimal commentId, decimal videoId, byte[] payload) returns Comment|error
Add a reply to a video comment
Parameters
- commentId decimal - The ID of the comment.
- videoId decimal - The ID of the video.
- payload byte[] -
getVideoCredits
function getVideoCredits(decimal videoId, string? direction, decimal? page, decimal? perPage, string? query, string? sort) returns Credit[]|error
Get all the credited users in a video
Parameters
- videoId decimal - The ID of the video.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- query string? (default ()) - The search query to use to filter the results.
- sort string? (default ()) - The way to sort the results.
addVideoCredit
Credit a user in a video
getVideoCredit
Get a specific credited user in a video
deleteVideoCredit
Delete a credit for a user in a video
editVideoCredit
Edit a credit for a user in a video
Parameters
- creditId decimal - The ID of the credit.
- videoId decimal - The ID of the video.
- payload byte[] -
getVideoLikes
function getVideoLikes(decimal videoId, string? direction, decimal? page, decimal? perPage, string? sort) returns User[]|error
Get all the users who have liked a video
Parameters
- videoId decimal - The ID of the video.
- direction string? (default ()) - The sort direction of the results.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
- sort string? (default ()) - The way to sort the results.
getVideoThumbnails
function getVideoThumbnails(decimal videoId, decimal? page, decimal? perPage) returns Picture[]|error
Get all the thumbnails of a video
Parameters
- videoId decimal - The ID of the video.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
createVideoThumbnail
Add a video thumbnail
getVideoThumbnail
Get a video thumbnail
deleteVideoThumbnail
Delete a video thumbnail
editVideoThumbnail
function editVideoThumbnail(decimal pictureId, decimal videoId, byte[] payload) returns Picture|error
Edit a video thumbnail
Parameters
- pictureId decimal - The ID of the picture.
- videoId decimal - The ID of the video.
- payload byte[] -
getVideoEmbedPreset
Check if an embed preset has been added to a video
addVideoEmbedPreset
Add an embed preset to a video
deleteVideoEmbedPreset
Remove an embed preset from a video
getVideoPrivacyDomains
function getVideoPrivacyDomains(decimal videoId, decimal? page, decimal? perPage) returns Domain[]|error
Get all the domains on which a video can be embedded
Parameters
- videoId decimal - The ID of the video.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
addVideoPrivacyDomain
Permit a video to be embedded on a domain
deleteVideoPrivacyDomain
Restrict a video from being embedded on a domain
getVideoPrivacyUsers
function getVideoPrivacyUsers(decimal videoId, decimal? page, decimal? perPage) returns User[]|error
Get all the users who can view a user's private videos by default
Parameters
- videoId decimal - The ID of the video.
- page decimal? (default ()) - The page number of the results to show.
- perPage decimal? (default ()) - The number of items to show on each page of results, up to a maximum of 100.
addVideoPrivacyUsers
Permit a list of users to view a private video
Parameters
- videoId decimal - The ID of the video.
addVideoPrivacyUser
Permit a specific user to view a private video
deleteVideoPrivacyUser
Restrict a user from viewing a private video
getVideoTags
Get all the tags of a video
Parameters
- videoId decimal - The ID of the video.
addVideoTags
Add a list of tags to a video
checkVideoForTag
Check if a tag has been added to a video
addVideoTag
Add a specific tag to a video
deleteVideoTag
Remove a tag from a video
getTextTracks
Get all the text tracks of a video
Parameters
- videoId decimal - The ID of the video.
createTextTrack
Add a text track to a video
getTextTrack
Get a specific text track
deleteTextTrack
Delete a text track
editTextTrack
function editTextTrack(decimal texttrackId, decimal videoId, byte[] payload) returns TextTrack|error
Edit a text track
Parameters
- texttrackId decimal - The ID of the text track.
- videoId decimal - The ID of the video.
- payload byte[] -
createVideoCustomLogo
Add a new custom logo to a video
Parameters
- videoId decimal - The ID of the video.
getVideoCustomLogo
Get a custom video logo
createVideoVersion
function createVideoVersion(decimal videoId, byte[] payload) returns VideoVersions|error
Add a version to a video
Return Type
- VideoVersions|error - Standard request.
getRelatedVideos
function getRelatedVideos(decimal videoId, string? filter, decimal? page, decimal? perPage) returns Video[]|error
Get all the related videos of a video
Records
vimeo: Activity31
Fields
- category record {}? - The category that this event occurred for. This will be preset for only "category" activity types.
- 'channel record {}? - The channel that this event occurred for. This will be present for only "channel" activity types.
- clip record {} - Video associated with ths activity.
- 'group record {}? - The group that this event occurred for. This will be present for only "group" activity types.
- metadata Activity31Metadata - The activity's metadata.
- tag record {}? - The tag that this event occurred for. This will be present for only "tag" activity types.
- time string - Time that the event occurred.
- 'type string - Activity type
- user record {}? - The user that this event occurred for. This will be present for "like", "appearance", and "share" activity types.
vimeo: Activity31Metadata
The activity's metadata.
Fields
- connections Activity31MetadataConnections - A list of resource URIs related to the activity.
vimeo: Activity31MetadataConnections
A list of resource URIs related to the activity.
Fields
- related Activity31MetadataConnectionsRelated - Related content for this activity.
vimeo: Activity31MetadataConnectionsRelated
Related content for this activity.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- uri string - The API URI that resolves to the connection data.
vimeo: Album
Fields
- allow_continuous_play boolean - Whether an album should allow continuous play.
- allow_downloads boolean - Whether an album should allow downloads.
- allow_share boolean - Whether an album should allow sharing.
- brand_color string - Hexadecimal color code for the decorative color. For example, album videos use this color for player buttons.
- created_time string - The time in ISO 8601 format that the album was created.
- custom_logo record {} - The custom logo for this album.
- description string - A brief description of the album's content.
- domain string - The custom domain a user has selected for their album.
- duration decimal - The total duration in seconds of all the videos in the album.
- embed AlbumEmbed - Embed data for the album.
- embed_brand_color boolean - Whether to show the album's custom brand color in the player of the album's embedded playlist.
- embed_custom_logo boolean - Whether to show the album's custom logo in the player of the album's embedded playlist.
- hide_nav boolean - Whether to hide the Vimeo navigation when viewing the album.
- hide_vimeo_logo boolean - Whether to hide the Vimeo logo in the player of the album's embedded playlist.
- layout string - The album's layout preference
- link string - The URL to access the album.
- metadata AlbumMetadata - Metadata about the album.
- modified_time string - The time in ISO 8601 format when the album was last modified.
- name string - The album's display name.
- pictures record {} - The active image for the album; defaults to the thumbnail of the last video added to the album.
- privacy AlbumPrivacy - The privacy settings of the album.
- resource_key string - The album resource key.
- review_mode boolean - Whether album videos should use the review mode URL.
- sort string - Sort type of the album.
- theme string - The album's color theme preference
- uri string - The album's URI.
- url string - The custom Vimeo URL a user has selected for their album.
- use_custom_domain boolean - Whether the user has opted in to use a custom domain for their album.
- user record {} - The owner of the album.
- web_brand_color boolean - Whether an album should show the brand color in the web layout.
- web_custom_logo boolean - Whether an album's custom logo should be shown in the web layout.
vimeo: AlbumEmbed
Embed data for the album.
Fields
- html string - The responsive HTML code to embed the playlist on a website. This is present only when
privacy.view
isn't password and when the album has embeddable videos.
vimeo: AlbumIdVideosBody
Fields
- videos string - A comma-separated list of video URIs.
vimeo: AlbumIdVideosBody1
Fields
- videos string - A comma-separated list of video URIs.
vimeo: AlbumMetadata
Metadata about the album.
Fields
- connections AlbumMetadataConnections - A collection of information that is connected to this resource.
- interactions AlbumMetadataInteractions - A list of resource URIs related to the album.
vimeo: AlbumMetadataConnections
A collection of information that is connected to this resource.
Fields
- videos AlbumMetadataConnectionsVideos - Information about the videos that belong to this album.
vimeo: AlbumMetadataConnectionsVideos
Information about the videos that belong to this album.
Fields
- options string[] - An array of the HTTP methods permitted on this URI.
- total decimal - The total number of videos on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: AlbumMetadataInteractions
A list of resource URIs related to the album.
Fields
- add_custom_thumbnails AlbumMetadataInteractionsAddCustomThumbnails - An action indicating that the authenticated user is an admin of the album and may therefore add custom thumbnails. This data requires a bearer token with the
private
scope.
- add_logos AlbumMetadataInteractionsAddLogos - An action indicating that the authenticated user is an admin of the album and may therefore add custom logos. This data requires a bearer token with the
private
scope.
- add_videos AlbumMetadataInteractionsAddVideos - An action indicating that the authenticated user is an admin of the album and may therefore add videos. This data requires a bearer token with the
private
scope.
vimeo: AlbumMetadataInteractionsAddCustomThumbnails
An action indicating that the authenticated user is an admin of the album and may therefore add custom thumbnails. This data requires a bearer token with the private
scope.
Fields
- options string[] - An array of HTTP methods permitted on this URI. This data requires a bearer token with the
private
scope.
- uri string - The API URI that resolves to the connection data. This data requires a bearer token with the
private
scope.
vimeo: AlbumMetadataInteractionsAddLogos
An action indicating that the authenticated user is an admin of the album and may therefore add custom logos. This data requires a bearer token with the private
scope.
Fields
- options string[] - An array of HTTP methods permitted on this URI. This data requires a bearer token with the
private
scope.
- uri string - The API URI that resolves to the connection data. This data requires a bearer token with the
private
scope.
vimeo: AlbumMetadataInteractionsAddVideos
An action indicating that the authenticated user is an admin of the album and may therefore add videos. This data requires a bearer token with the private
scope.
Fields
- options string[] - An array of HTTP methods allowed on this URI. This data requires a bearer token with the
private
scope.
- uri string - The API URI that resolves to the connection data. This data requires a bearer token with the
private
scope.
vimeo: AlbumPrivacy
The privacy settings of the album.
Fields
- password string? - The privacy-enabled password to see this album. Present only when
privacy.view
ispassword
.
- view string - Who can view the album:
Option descriptions:
anybody
- Anyone can view the album.embed_only
- Only owner can see album, can be embedded off-sitepassword
- Only those with the password can view the album.
vimeo: AlbumsAlbumIdBody
Fields
- brand_color string? - The hexadecimal code for the color of the player buttons.
- description string? - The description of the album.
- domain string? - The custom domain a user has selected for their album.
- hide_nav boolean? - Whether to hide Vimeo navigation when displaying the album.
- layout string? - The type of layout for presenting the album.
- name string? - The name of the album.
- password string? - The album's password. Required only if privacy is
password
.
- privacy string? - The privacy level of the album.
- review_mode boolean? - Whether album videos should use the review mode URL.
- sort string? - The default sort order of the album's videos.
- theme string? - The color theme of the album.
- url string? - The custom Vimeo URL a user has selected for their album.
- use_custom_domain boolean? - Whether the user has opted in to use a custom domain for their album.
vimeo: AlbumsAlbumIdBody1
Fields
- brand_color string? - The hexadecimal code for the color of the player buttons.
- description string? - The description of the album.
- domain string? - The custom domain a user has selected for their album.
- hide_nav boolean? - Whether to hide Vimeo navigation when displaying the album.
- layout string? - The type of layout for presenting the album.
- name string? - The name of the album.
- password string? - The album's password. Required only if privacy is
password
.
- privacy string? - The privacy level of the album.
- review_mode boolean? - Whether album videos should use the review mode URL.
- sort string? - The default sort order of the album's videos.
- theme string? - The color theme of the album.
- url string? - The custom Vimeo URL a user has selected for their album.
- use_custom_domain boolean? - Whether the user has opted in to use a custom domain for their album.
vimeo: ApiApp
Fields
- name string - The name of the API app.
- uri string - The canonical URI of the API app.
vimeo: Auth
Fields
- access_token string - The access token string.
- app record {} - The API application associated with the token.
- expires_on string? - The date and time that the token expires.
- refresh_token string? - The refresh token string.
- scope string - The scope or scopes that the token supports.
- token_type string - The token type:
Option descriptions:
bearer
- The token is of thebearer
type.
- user record {}? - The user associated with the token.
vimeo: AuthError
Fields
- _error string - The name of the error.
- error_description string - The description of the error.
vimeo: AuthorizeClientBody
Fields
- grant_type string - The grant type. Must be set to
client_credentials
.
vimeo: AuthorizeVimeoOauth1Body
Fields
- grant_type string - The grant type. Must be set to
vimeo_oauth1
.
- token string - The OAuth 1 token.
- token_secret string - The OAuth 1 token secret.
vimeo: BackgroundsBackgroundIdBody
Fields
- active boolean? - Whether to make this background the active background.
vimeo: Category
Fields
- icon record {}? - The active icon for the category.
- last_video_featured_time string - The last time, in ISO 8601 format, that a video was featured.
- link string - The URL to access the category in a browser.
- metadata CategoryMetadata - Metadata about the category.
- name string - The display name that identifies the category.
- parent CategoryParent - The container of this category's parent category, if the current category is a subcategory.
- pictures record {} - The active picture for this category; defaults to vertical color bars.
- resource_key string - The resource key of the category.
- subcategories CategorySubcategories[]? - All the subcategories that belong to this category, if the current category is a top-level parent.
- top_level boolean - Whether the category isn't a subcategory of another category.
- uri string - The unique identifier to access the category resource.
vimeo: CategoryMetadata
Metadata about the category.
Fields
- connections CategoryMetadataConnections - A collection of information that is connected to this resource.
- interactions CategoryMetadataInteractions - The permissible actions related to the category.
vimeo: CategoryMetadataConnections
A collection of information that is connected to this resource.
Fields
- channels CategoryMetadataConnectionsChannels - Information about the channels related to this category.
- groups CategoryMetadataConnectionsGroups - Information about the groups related to this category.
- users CategoryMetadataConnectionsUsers - Information about the users related to this category.
- videos CategoryMetadataConnectionsVideos - Information about the videos related to this category.
vimeo: CategoryMetadataConnectionsChannels
Information about the channels related to this category.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of channels on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: CategoryMetadataConnectionsGroups
Information about the groups related to this category.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of groups on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: CategoryMetadataConnectionsUsers
Information about the users related to this category.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of users on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: CategoryMetadataConnectionsVideos
Information about the videos related to this category.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of videos on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: CategoryMetadataInteractions
The permissible actions related to the category.
Fields
- follow CategoryMetadataInteractionsFollow - An action indicating if the authenticated user has followed this category.
vimeo: CategoryMetadataInteractionsFollow
An action indicating if the authenticated user has followed this category.
Fields
- added boolean - Whether the authenticated user has followed this category.
- added_time string - The time in ISO 8601 format that the user followed this category, or the null value if the user hasn't followed this category.
- uri string - The URI for following or unfollowing this category: PUT to this URI to follow the category, or DELETE to this URI to unfollow the category.
vimeo: CategoryParent
The container of this category's parent category, if the current category is a subcategory.
Fields
- link string - The URL to access the parent category in a browser.
- name string - The display name that identifies the parent category.
- uri string - The unique identifier to access the parent of this category resource.
vimeo: CategorySubcategories
Fields
- link string - The URL to access the subcategory in a browser.
- name string - The display name that identifies the subcategory.
- uri string - The unique identifier to access the subcategory resource.
vimeo: Channel
Fields
- categories Category[] - The categories to which this channel belongs as specified by the channel moderators.
- created_time string - The time in ISO 8601 format when the channel was created.
- description string - A brief explanation of the channel's content.
- header record {} - The banner that appears by default at the top of the channel page.
- link string - The URL to access the channel in a browser.
- metadata ChannelMetadata - Metadata about the channel.
- modified_time string - The time in ISO 8601 format when the album was last modified.
- name string - The display name that identifies the channel.
- pictures record {} - The active image for the channel; defaults to the thumbnail of the last video added to the channel.
- privacy ChannelPrivacy - The privacy settings of the channel.
- resource_key string - The channel resource key.
- tags Tag[] - An array of all tags assigned to this channel.
- uri string - The unique identifier to access the channel resource.
- user record {} - The Vimeo user who owns the channel.
vimeo: ChannelIdCategoriesBody
Fields
- channels string[] - The array of category URIs to add.
vimeo: ChannelIdModeratorsBody
Fields
- user_uri string - The URI of a user to add as a moderator.
vimeo: ChannelIdModeratorsBody1
Fields
- user_uri string - The URI of the user to add as a moderator.
vimeo: ChannelIdTagsBody
Fields
- tag string[] - An array of tags to assign.
vimeo: ChannelIdVideosBody
Fields
- video_uri string - The URI of a video to add.
vimeo: ChannelMetadata
Metadata about the channel.
Fields
- connections ChannelMetadataConnections - A collection of information that is connected to this resource.
- interactions ChannelMetadataInteractions - A list of resource URIs related to the channel.
vimeo: ChannelMetadataConnections
A collection of information that is connected to this resource.
Fields
- privacy_users ChannelMetadataConnectionsPrivacyUsers - Information provided to channel moderators about which users they have specifically permitted to access a private channel. This data requires a bearer token with the
private
scope.
- users ChannelMetadataConnectionsUsers - Information about the users following or moderating this channel.
- videos ChannelMetadataConnectionsVideos - Information about the videos that belong to this channel.
vimeo: ChannelMetadataConnectionsPrivacyUsers
Information provided to channel moderators about which users they have specifically permitted to access a private channel. This data requires a bearer token with the private
scope.
Fields
- options string[] - An array of HTTP methods permitted on this URI. This data requires a bearer token with the
private
scope.
- total decimal - The total number of users on this connection. This data requires a bearer token with the
private
scope.
- uri string - The API URI that resolves to the connection data. This data requires a bearer token with the
private
scope.
vimeo: ChannelMetadataConnectionsUsers
Information about the users following or moderating this channel.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of users on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: ChannelMetadataConnectionsVideos
Information about the videos that belong to this channel.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of videos on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: ChannelMetadataInteractions
A list of resource URIs related to the channel.
Fields
- add_moderators ChannelMetadataInteractionsAddModerators - An action indicating that the authenticated user is the owner of the channel and may therefore add other users as channel moderators. This data requires a bearer token with the
private
scope.
- add_to ChannelMetadataInteractionsAddTo - When a channel appears in the context of adding or removing a video from it (
/videos/{video_id}/available_channels
), include information about adding or removing the video. This data requires a bearer token with theprivate
scope.
- follow ChannelMetadataInteractionsFollow - An action indicating if the authenticated user has followed this channel. This data requires a bearer token with the
private
scope.
- moderate_videos ChannelMetadataInteractionsModerateVideos - An action indicating that the authenticated user is a moderator of the channel and may therefore add or remove videos from the channel. This data requires a bearer token with the
private
scope.
vimeo: ChannelMetadataInteractionsAddModerators
An action indicating that the authenticated user is the owner of the channel and may therefore add other users as channel moderators. This data requires a bearer token with the private
scope.
Fields
- options string[] - An array of HTTP methods permitted on this URI. This data requires a bearer token with the
private
scope.
- uri string - The API URI that resolves to the connection data. This data requires a bearer token with the
private
scope.
vimeo: ChannelMetadataInteractionsAddTo
When a channel appears in the context of adding or removing a video from it (/videos/{video_id}/available_channels
), include information about adding or removing the video. This data requires a bearer token with the private
scope.
Fields
- options string[] - An array of HTTP methods permitted on this URI. This data requires a bearer token with the
private
scope.
- uri string - The API URI that resolves to the connection data. This data requires a bearer token with the
private
scope.
vimeo: ChannelMetadataInteractionsFollow
An action indicating if the authenticated user has followed this channel. This data requires a bearer token with the private
scope.
Fields
- added boolean - Whether the authenticated user has followed this channel. This data requires a bearer token with the
private
scope.
- added_time string - The time in ISO 8601 format that the user followed this channel, or the null value if the user hasn't followed the channel. This data requires a bearer token with the
private
scope.
- 'type string - Whether the authenticated user is a moderator or subscriber. This data requires a bearer token with the
private
scope. Option descriptions:moderator
- The authenticated user is a moderator.subscriber
- The authenticated user is a subscriber.
- uri string - The URI for following or unfollowing this channel. PUT to this URI to follow the channel, or DELETE to this URI to unfollow the channel. This data requires a bearer token with the
private
scope.
vimeo: ChannelMetadataInteractionsModerateVideos
An action indicating that the authenticated user is a moderator of the channel and may therefore add or remove videos from the channel. This data requires a bearer token with the private
scope.
Fields
- options string[] - An array of HTTP methods allowed on this URI. This data requires a bearer token with the
private
scope.
- uri string - The API URI that resolves to the connection data. This data requires a bearer token with the
private
scope.
vimeo: ChannelPrivacy
The privacy settings of the channel.
Fields
- view string - Who can view the channel:
Option descriptions:
anybody
- Anyone can view the channel.moderators
- Only moderators can view the channel.users
- Only registered users can view the channel.
vimeo: ChannelsBody
Fields
- description string? - The description of the channel.
- link string? - The link to access the channel. You can use a custom name in the URL in place of a numeric channel ID, as in
/channels/{url_custom}
.
- name string - The name of the channel.
- privacy string - The privacy level of the channel.
vimeo: ChannelsChannelIdBody
Fields
- description string? - The description of the channel.
- link string? - The link to access the channel. You can use a custom name in the URL in place of a numeric channel ID, as in
/channels/{url_custom}
. Submitting""
for this field removes the link alias.
- name string? - The name of the channel.
- privacy string? - The privacy level of the channel.
vimeo: ClientConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth OAuth2ClientCredentialsGrantConfig|BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion string(default "1.1") - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- followRedirects FollowRedirects?(default ()) - Configurations associated with Redirection
- poolConfig PoolConfiguration?(default ()) - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig?(default ()) - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig?(default ()) - Configurations associated with retrying
- cookieConfig CookieConfig?(default ()) - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket?(default ()) - SSL/TLS-related options
vimeo: Comment
Fields
- created_on string - The time in ISO 8601 format when the comment was posted.
- metadata CommentMetadata -
- resource_key string - The resource key string for the comment.
- text string - The content of the comment.
- 'type string - The Vimeo content to which the comment relates:
Option descriptions:
video
- The comment is about a video.
- uri string - The unique identifier to access the comment resource.
- user record {} - The user who posted the comment.
vimeo: CommentIdRepliesBody
Fields
- text string - The reply to the comment.
vimeo: CommentMetadata
Fields
- connections CommentMetadataConnections -
vimeo: CommentMetadataConnections
Fields
- replies CommentMetadataConnectionsReplies - Information about this comment's replies.
vimeo: CommentMetadataConnectionsReplies
Information about this comment's replies.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of replies on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: CommentsCommentIdBody
Fields
- text string - The next text of the comment.
vimeo: ContentRating
Fields
- code string - The code that uniquely identifies this content rating:
Option descriptions:
drugs
- Drug or alcohol use.language
- Profanity or sexually suggestive content.nudity
- Nudity.safe
- Suitable for all audiences.unrated
- No rating.violence
- Violent or graphic content.
- name string - The description of this content rating.
- uri string - The canonical relative URI of the content rating.
vimeo: CreativeCommons
Fields
- code string - The code that uniquely identifies this Creative Commons license:
Option descriptions:
by
- Attributionby-nc
- Attribution Non-Commercialby-nc-nd
- Attribution Non-Commercial No Derivativesby-nc-sa
- Attribution Non-Commercial Share Alikeby-nd
- Attribution No Derivativesby-sa
- Attribution Share Alikecc0
- Public Domain Dedication
- name string - The description of this Creative Commons license.
- uri string - The canonical relative URI of the Creative Commons license.
vimeo: Credit
Fields
- name string - The name of the person credited.
- role string - The character that this person portrayed, or the job that this person performed.
- uri string - The unique identifier to access the credits resource.
- user record {}? - The Vimeo user associated with this credit.
- video record {}? - The video associated with this credit.
vimeo: CreditsCreditIdBody
Fields
- name string? - The name of the person being credited.
- role string? - The role of the person being credited.
vimeo: CustomThumbnailsThumbnailIdBody
Fields
- active boolean? - Whether to make this the active album thumbnail.
vimeo: Domain
Fields
- allow_hd boolean - Whether to permit HD embeds on this domain.
- domain string - The domain name.
- uri string - The URI of the domain.
vimeo: EmbedSettings
Fields
- buttons EmbedsettingsButtons - A collection of information about the buttons that appear on the interface of the embeddable player.
- color string - The primary player color, which controls the color of the progress bar, buttons, and more.
- logos EmbedsettingsLogos - A collection of information about the logo in the corner of the embeddable player.
- playbar boolean - Whether the playbar appears in the embeddable player for this video.
- speed boolean - Whether the speed controls appear in the embeddable player for this video.
- title EmbedsettingsTitle - A collection of information relating to the embeddable player's title bar.
- uri string? - The URI of the embed preset.
- volume boolean - Whether the volume controls appear in the embeddable player for this video.
vimeo: EmbedsettingsButtons
A collection of information about the buttons that appear on the interface of the embeddable player.
Fields
- embed boolean - Whether the Embed button appears in the embeddable player for this video.
- fullscreen boolean - Whether the Fullscreen button appears in the embeddable player for this video.
- hd boolean - Whether the HD button appears in the embeddable player for this video.
- like boolean - Whether the Like button appears in the embeddable player for this video.
- scaling boolean - Whether the Scaling button appears in the embeddable player for this video.
- share boolean - Whether the Share button appears in the embeddable player for this video.
- watchlater boolean - Whether the Watch Later button appears in the embeddable player for this video.
vimeo: EmbedsettingsLogos
A collection of information about the logo in the corner of the embeddable player.
Fields
- custom EmbedsettingsLogosCustom - A collection of information relating to custom logos in the embeddable player.
- vimeo boolean - Whether the Vimeo logo appears in the embeddable player for this video.
vimeo: EmbedsettingsLogosCustom
A collection of information relating to custom logos in the embeddable player.
Fields
- active boolean - Whether the custom logo appears in the embeddable player.
- link string - The URL that loads upon clicking the custom logo.
- sticky boolean - Whether the custom logo appears even when the player interface is hidden.
vimeo: EmbedsettingsTitle
A collection of information relating to the embeddable player's title bar.
Fields
- name string - How the embeddable player handles the video title:
Option descriptions:
hide
- The title is hidden.show
- The title is shown.
- owner string - How the embeddable player handles the video owner's information:
Option descriptions:
hide
- The owner's information is hidden.show
- The owner's information is shown.
- portrait string - How the embeddable player handles the video owner's portrait:
Option descriptions:
hide
- The owner's portrait is hiddenshow
- The owner's portrait is shown.
vimeo: Endpoint
Fields
- methods string[] - All HTTP methods permitted on this endpoint.
- path string - The path section of the URL, which, when appended to the API host
https:///api.vimeo.com
, builds a full API endpoint.
vimeo: Error
Fields
- developer_message string - The error message that developers receive.
- _error string - The error message that non-developer users receive.
- error_code decimal - The error code.
- link string - A link to more information about the error.
vimeo: Group
Fields
- created_time string - The time in ISO 8601 format when the group was created.
- description string - The group's description.
- link string - The link to the group.
- metadata GroupMetadata - Metadata about the group.
- modified_time string - The time in ISO 8601 format when the group was last modified.
- name string - The group's display name.
- pictures record {} - The active picture for this group.
- privacy GroupPrivacy - The group's privacy settings.
- resource_key string - The resource key of the group.
- uri string - The canonical relative URI of this group.
- user record {}? - The owner of the group.
vimeo: GroupMetadata
Metadata about the group.
Fields
- connections GroupMetadataConnections - A collection of information that is connected to this resource.
- interactions GroupMetadataInteractions - User actions that have involved the group. This data requires a bearer token with the
private
scope.
vimeo: GroupMetadataConnections
A collection of information that is connected to this resource.
Fields
- users GroupMetadataConnectionsUsers - Information about the members or moderators of this group.
- videos GroupMetadataConnectionsVideos - Information about the videos contained within this group.
vimeo: GroupMetadataConnectionsUsers
Information about the members or moderators of this group.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of users on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: GroupMetadataConnectionsVideos
Information about the videos contained within this group.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of videos on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: GroupMetadataInteractions
User actions that have involved the group. This data requires a bearer token with the private
scope.
Fields
- 'join GroupMetadataInteractionsJoin - An action indicating that someone has joined the group. This data requires a bearer token with the
private
scope.
vimeo: GroupMetadataInteractionsJoin
An action indicating that someone has joined the group. This data requires a bearer token with the private
scope.
Fields
- added boolean - Whether the authenticated user has followed this group. This data requires a bearer token with the
private
scope.
- added_time string - The time in ISO 8601 format when the user joined this group. This data requires a bearer token with the
private
scope.
- title string - The user's title, or the null value if not applicable. This data requires a bearer token with the
private
scope.
- 'type string - Whether the authenticated user is a moderator or subscriber. This data requires a bearer token with the
private
scope. Option descriptions:member
- The authenticated user is a member.moderator
- The authenticated user is a moderator.
- uri string - The URI for following. PUT to this URI to follow, or DELETE to this URI to unfollow. This data requires a bearer token with the
private
scope.
vimeo: GroupPrivacy
The group's privacy settings.
Fields
- comment string - Who can comment on the group:
Option descriptions:
all
- Anyone can comment on the group.members
- Only members can comment on the group.
- invite string - Who can invite new members to the group:
Option descriptions:
all
- Anyone can invite new members to join.members
- Only group members can invite new members to join.
- 'join string - Who can join the group:
Option descriptions:
anybody
- Anyone can join the group.members
- Only people with a Vimeo account can join the group.
- videos string - Who can add videos to the group:
Option descriptions:
all
- Anyone can add videos to the group.members
- Only group members can add videos to the group.
- view string - Who can view the group:
Option descriptions:
anybody
- Anyone can view the group.members
- Only group members can view the group.
vimeo: GroupsBody
Fields
- description string? - The description of the new group.
- name string - The name of the new group.
vimeo: Language
Fields
- code string - The code that represents this language.
- name string - The name of the language.
vimeo: LegacyError
Fields
- _error string - User-friendly error message
vimeo: LogosLogoIdBody
Fields
- active boolean? - Whether to make this the active album logo.
vimeo: MeAlbumsBody
Fields
- brand_color string? - The hexadecimal code for the color of the player buttons.
- description string? - The description of the album.
- hide_nav boolean? - Whether to hide Vimeo navigation when displaying the album.
- layout string? - The type of layout for presenting the album.
- name string - The name of the album.
- password string? - The album's password. Required only if privacy is
password
.
- privacy string? - The privacy level of the album.
- review_mode boolean? - Whether album videos should use the review mode URL.
- sort string? - The default sort order of the album's videos.
- theme string? - The color theme of the album.
vimeo: MeBody
Fields
- bio string? - The user's bio.
- content_filter string[]? - A list of values describing the content in this video. Find the full list in the /contentratings endpoint. You must provide a comma-separated list if you are using a query string or an array if you are using JSON.
- link string? - The user's custom Vimeo URL slug.
- location string? - The user's location.
- name string? - The user's display name.
- password string? - The default password for all future videos that this user uploads. To use this field, the
videos.privacy.view
field must bepassword
.
- videos MeVideos? -
vimeo: MeFollowingBody
Fields
- users string[] - An array of user URIs for the list of users to follow.
vimeo: MeondemandpagesBuy
Fields
- active boolean? - Whether the Buy action is active. *Required if
rent.active
is false.
- download boolean? - Whether people who buy the video can download it. To use this field,
type
must befilm
.
- price MeondemandpagesBuyPrice? -
vimeo: MeondemandpagesBuyPrice
Fields
- AUD decimal? - The purchase price of this video in AUD.
- CAD decimal? - The purchase price of this video in CAD.
- CHF decimal? - The purchase price of this video in CHF.
- DKK decimal? - The purchase price of this video in DKK.
- EUR decimal? - The purchase price of this video in EUR.
- GBP decimal? - The purchase price of this video in GBP.
- JPY decimal? - The purchase price of this video in JPY.
- KRW decimal? - The purchase price of this video in KRW.
- NOK decimal? - The purchase price of this video in NOK.
- PLN decimal? - The purchase price of this video in PLN.
- SEK decimal? - The purchase price of this video in SEK.
- USD decimal? - The purchase price of this video in USD when
type
isfilm
, or the purchase price of the entire collection in USD whentype
isseries
.
vimeo: MeondemandpagesEpisodes
Fields
- buy MeondemandpagesEpisodesBuy? -
- rent MeondemandpagesEpisodesRent? -
vimeo: MeondemandpagesEpisodesBuy
Fields
- active boolean? - Whether episodes can be bought.
- download boolean? - Whether people who buy the episode can download it. To use this field,
type
must beseries
.
- price MeondemandpagesEpisodesBuyPrice? -
vimeo: MeondemandpagesEpisodesBuyPrice
Fields
- USD decimal? - The purchase price per episode. *Required if
episodes.buy.active
is true.
vimeo: MeondemandpagesEpisodesRent
Fields
- active boolean? - Whether episodes can be rented
- period string? - The period in which this episode can be rented for.
- price MeondemandpagesEpisodesRentPrice? -
vimeo: MeondemandpagesEpisodesRentPrice
Fields
- USD decimal? - The default price to rent an episode. This field is applicable only when
type
isseries
. *Required ifepisodes.rent.active
is true.
vimeo: MeondemandpagesRent
Fields
- active boolean? - Whether the video can be rented. *Required if
buy.active
is false.
- period string? - The period in which this can be rented for.
- price MeondemandpagesRentPrice? -
vimeo: MeondemandpagesRentPrice
Fields
- AUD decimal? - The rental price of this video in AUD.
- CAD decimal? - The rental price of this video in CAD.
- CHF decimal? - The rental price of this video in CHF.
- DKK decimal? - The rental price of this video in DKK.
- EUR decimal? - The rental price of this video in EUR.
- GBP decimal? - The rental price of this video in GBP.
- JPY decimal? - The rental price of this video in JPY.
- KRW decimal? - The rental price of this video in KRW.
- NOK decimal? - The rental price of this video in NOK.
- PLN decimal? - The rental price of this video in PLN.
- SEK decimal? - The rental price of this video in SEK.
- USD decimal? - The rental price of this video in USD when
type
isfilm
, or the rental price of the entire collection in USD whentype
isseries
.
vimeo: MeondemandpagesSubscription
Fields
- monthly MeondemandpagesSubscriptionMonthly? -
vimeo: MeondemandpagesSubscriptionMonthly
Fields
- active boolean? - Whether monthly subscription is active. *Required if
rent.active
andbuy.active
are false.
vimeo: MeondemandpagesSubscriptionMonthlyPrice
Fields
- USD decimal? - The monthly subscription price in USD. *Required if
subscription.active
is true.
vimeo: MeProjectsBody
Fields
- name string - The name of the project.
vimeo: MeVideos
Fields
- privacy MeVideosPrivacy? -
vimeo: MeVideosBody
Fields
- content_rating string[]? - A list of values describing the content in this video. Find the full list in the /contentratings endpoint.
- description string? - The description of the video.
- embed MevideosEmbed? -
- license string? - The Creative Commons license.
- locale string? - The video's default language. For a full list of valid languages, use the /languages?filter=texttracks endpoint.
- name string? - The title of the video.
- password string? - The password. When you set
privacy.view
topassword
, you must provide the password as an additional parameter.
- privacy MevideosPrivacy? -
- ratings MevideosRatings? -
- review_page MevideosReviewPage? -
- spatial MevideosSpatial? -
- upload MevideosUpload -
vimeo: MevideosEmbed
Fields
- buttons MevideosEmbedButtons? -
- color string? - The main color of the embed player.
- logos MevideosEmbedLogos? -
- playbar boolean? - Show or hide the playbar.
- title MevideosEmbedTitle? -
- volume boolean? - Show or hide the volume selector.
vimeo: MevideosEmbedButtons
Fields
- embed boolean? - Show or hide the Embed button.
- fullscreen boolean? - Show or hide the Fullscreen button.
- hd boolean? - Show or hide the HD button.
- like boolean? - Show or hide the Like button.
- scaling boolean? - Show or hide the Scaling button (shown only in Fullscreen mode).
- share boolean? - Show or hide the Share button.
- watchlater boolean? - Show or hide the Watch Later button.
vimeo: MevideosEmbedLogos
Fields
- custom MevideosEmbedLogosCustom? -
- vimeo boolean? - Show or hide the Vimeo logo.
vimeo: MevideosEmbedLogosCustom
Fields
- active boolean? - Show or hide your custom logo.
- link string? - The URL that loads when the user clicks your custom logo.
- sticky boolean? - Whether always to show the custom logo or to hide it after time with the rest of the UI.
vimeo: MevideosEmbedTitle
Fields
- name string? - Show or hide the video title, or enable the user to determine whether the video title appears.
- owner string? - Show or hide the owner information, or enable the user to determine whether the owner information appears.
- portrait string? - Show or hide the owner portrait, or enable the user to determine whether the owner portrait appears.
vimeo: MevideosPrivacy
Fields
- add boolean? - Whether a user can add the video to an album, channel, or group.
- comments string? - The privacy level required to comment on the video.
- download boolean? - Whether a user can download the video. Not available to users with a Basic membership
- embed string? - The video's embed settings. The
whitelist
value enables you to define all valid embed domains. See our documentation for details on adding and removing domains.
- view string? - The video's privacy setting. When privacy is
users
,application/json
is the only valid content type. Basic users can't set privacy tounlisted
.
vimeo: MeVideosPrivacy
Fields
- add boolean? - Whether a user can add the video to an album, channel, or group. This value becomes the default add setting for all future videos uploaded by the user.
- comments string? - Who can comment on the video. This value becomes the default comment setting for all future videos that this user uploads.
- download boolean? - Whether a user can download the video. This value becomes the default download setting for all future videos that this user uploads.
- embed string? - The privacy for embed videos. The
whitelist
value enables you to define all valid embed domains. See our documentation for adding and removing domains.
- view string? - Who can view the video. This value becomes the default view setting for all future videos that this user uploads.
vimeo: MevideosRatings
Fields
- mpaa MevideosRatingsMpaa? -
- tv MevideosRatingsTv? -
vimeo: MevideosRatingsMpaa
Fields
- reason string? - The reason for the video's MPAA rating.
Option descriptions:
at
- Adult themesbn
- Brief nudityn
- Nuditysl
- Strong languagess
- Sexual situationsv
- Violence
vimeo: MevideosRatingsTv
Fields
- reason string? - The reason for the video's TV rating.
Option descriptions:
d
- Suggestive dialoguefv
- Fantasy violencel
- Languagess
- Sexual situationsv
- Violence
vimeo: MevideosReviewPage
Fields
- active boolean? - Enable or disable video review.
vimeo: MevideosSpatial
Fields
- director_timeline MevideosSpatialDirectorTimeline[]? - The 360 director timeline.
- field_of_view decimal? - The 360 field of view: default 50, minimum 30, maximum 90.
- projection string? - The 360 spatial projection.
- stereo_format string? - The 360 spatial stereo format.
vimeo: MevideosSpatialDirectorTimeline
Fields
- pitch decimal - The timeline pitch. This value must be between -90 and 90.
- roll decimal? - The timeline roll.
- time_code decimal - The 360 director timeline time code.
- yaw decimal - The timeline yaw. This value must be between 0 and 360.
vimeo: MevideosUpload
Fields
- approach string - The upload approach.
- link string? - The public URL at which the video is hosted. The URL must be valid for at least 24 hours. Use this parameter when
approach
ispull
.
- redirect_url string? - The app's redirect URL. Use this parameter when
approach
ispost
.
- size string? - The size in bytes of the video to upload.
vimeo: OAuth2ClientCredentialsGrantConfig
OAuth2 Client Credintials Grant Configs
Fields
- Fields Included from *OAuth2ClientCredentialsGrantConfig
- tokenUrl string
- clientId string
- clientSecret string
- scopes string[]
- defaultTokenExpTime decimal
- clockSkew decimal
- optionalParams map<string>
- credentialBearer CredentialBearer
- clientConfig ClientConfiguration
- tokenUrl string(default "https://api.vimeo.com/oauth/access_token") - Token URL
vimeo: OauthAccessTokenBody
Fields
- code string - The authorization code received from the authorization server.
- grant_type string - The grant type. Must be set to
authorization_code
.
- redirect_uri string - The redirect URI. Must match the URI from
/oauth/authorize
.
vimeo: OnDemandGenre
Fields
- canonical string - The canonical name or URL slug of the genre.
- interactions OndemandgenreInteractions -
- link string - The Vimeo URL for this genre.
- metadata OndemandgenreMetadata -
- name string - The descriptive name of the genre.
- uri string - The relative URI of the On Demand genre.
vimeo: OndemandgenreInteractions
Fields
- page OndemandgenreInteractionsPage - Interactions for On Demand pages that are in this genre.
vimeo: OndemandgenreInteractionsPage
Interactions for On Demand pages that are in this genre.
Fields
- added boolean - Whether this On Demand genre was added.
- options string[] - An array of HTTP methods permitted on this URI.
- uri string - The URI to access the On Demand page.
vimeo: OndemandgenreMetadata
Fields
- connections OndemandgenreMetadataConnections - A collection of information connected to this resource.
vimeo: OndemandgenreMetadataConnections
A collection of information connected to this resource.
Fields
- pages OndemandgenreMetadataConnectionsPages - Information about the On Demand pages related to this group.
vimeo: OndemandgenreMetadataConnectionsPages
Information about the On Demand pages related to this group.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- uri string - The API URI that resolves to the connection data.
vimeo: OndemandIdPromotionsBody
Fields
- access_type string? - The promotion access type, which is a purchase option that isn't available on the container. VIP promotions always make the content free of charge. If you use this type, you must further define the promotion with the
download
orstream_period
fields. Option descriptions:default
- Promotions grant discount on the existing purchase options for an On Demand Container.vip
- Promotions can be used to grant free access to VOD content before it is released, or to offer a purchase option that isn't available on the container. "vip" promotions will always make the content free, and must be further defined with thedownload
orstream_period
fields.
- code string? - The promotion code. This field is ignored for batch promotions.
- discount_type string? - The type of discount offered by the promo code. When
access_type
isvip
, the value of this field must befree
. Option descriptions:free
- Reduces the price to zero.percent
- Reduces the price by an amount defined in the "percent_off" field.
- download boolean - Whether the promotion grants download access to VOD content. This is necessary only when not previously defined in the On Demand container or when
access_type
isvip
orproduct_type
isbuy
.
- end_time string? - The end of the promotion period. If you don't specify a value, the promotion will never expire.
- label string? - The description of a batch promotion. This field is ignored for single promotions.
- percent_off decimal? - The percentage of the discount by using this promo code. This field is applicable only when
discount_type
ispercent
.
- product_type string? - The type of transaction to which the promotion applies. When
access_type
isdefault
, the default value isany
, but the default value isrent
whenaccess_type
isvip
. Also, whenaccess_type
isvip
, the only valid product types arebuy
andrent
.
- start_time string? - The start of the promotion period. If you don't specify a value, the start time defaults to the time that the promotion was created.
- stream_period string - The amount of time that a user has access to the VOD content upon redeeming a promo code. This field is necessary only when not defined in the On Demand container or when creating promotions when
access_type
isvip
orproduct_type
isrent
.
- total decimal - The number of promotions to generate when
type
isbatch
, or the number of uses of the promotion whentype
issingle
.
- 'type string - The type of promotion. When
access_type
isvip
, the value for this field must bebatch
. Option descriptions:batch
- Generates many random promo codes with one use each.single
- Generates one promo code that can be used many times.
vimeo: OndemandIdRegionsBody
Fields
- countries string[] - An array of country codes.
vimeo: OnDemandPage
Fields
- background record {} - The background image for the On Demand page on Vimeo.
- colors OndemandpageColors - The primary and secondary colors used for rendering this On Demand page.
- content_rating string[] - An array of the page's content ratings.
- created_time string? - The time in ISO 8601 format when the page was created.
- description string - The description of this On Demand page.
- domain_link string - The link to this page on its own domain.
- episodes OndemandpageEpisodes - Information about this On Demand page's episodes, if the page is for a series.
- film record {}? - This On Demand page's film, if it is a film.
- genres OnDemandGenre[] - All the genres assigned to this page.
- link string - The link to the page on Vimeo.
- metadata OndemandpageMetadata - Metadata about the On Demand page.
- modified_time string? - he time in ISO 8601 format when the page was last modified.
- name string - A descriptive title of this On Demand page.
- pictures record {} - The active poster for this On Demand page.
- preorder OndemandpagePreorder -
- published OndemandpagePublished -
- rating decimal - The rating of this page.
- resource_key string - The VOD resource key.
- sku string? - The creator-designated SKU for this On Demand page.
- subscription OndemandpageSubscription - Information about subscribing to this On Demand page, if enabled.
- theme string - The graphical theme for this On Demand page.
- thumbnail record {} - The thumbnail image for the On Demand page on Vimeo.
- trailer record {} - The trailer for this On Demand page.
- 'type string - Whether this On Demand page is for a film or a series.
Option descriptions:
film
- The On Demand page is for a film.series
- The On Demand page is for a series.
- uri string - The relative URI of the On Demand page.
- user record {} - The user who created this On Demand page.
vimeo: OndemandpageColors
The primary and secondary colors used for rendering this On Demand page.
Fields
- primary string - The hexadecimal color code for the page's primary color.
- secondary string - The hexadecimal color code for the page's secondary color.
vimeo: OndemandpageEpisodes
Information about this On Demand page's episodes, if the page is for a series.
Fields
- buy OndemandpageEpisodesBuy -
- rent OndemandpageEpisodesRent -
vimeo: OndemandpageEpisodesBuy
Fields
- active boolean - Whether all the videos on this On Demand page can be purchased as a whole.
- price decimal - The default price to buy an episode.
vimeo: OndemandpageEpisodesRent
Fields
- active boolean - Whether all the videos on this On Demand page can be rented as a whole.
- period string - The rental period for the video:
Option descriptions:
1 day
- The rental period is one day.1 month
- The rental period is one month.1 week
- The rental period is one week.1 year
- The rental period is one year.2 day
- The rental period is two days.24 hour
- The rental period is 24 hours.3 day
- The rental period is three days.3 month
- The rental period is three months.30 day
- The rental period is 30 days.48 hour
- The rental period is 48 hours.6 month
- The rental period is six months.60 day
- The rental period is 60 days.7 day
- The rental period is 7 days.72 hour
- The rental period is 72 hours.
- price decimal - The default price to rent an episode.
vimeo: OndemandpageMetadata
Metadata about the On Demand page.
Fields
- connections OndemandpageMetadataConnections - A collection of information that is connected to this resource, including videos, genres, and pictures connections.
- interactions record {} - The user's available purchase interactions.
vimeo: OndemandpageMetadataConnections
A collection of information that is connected to this resource, including videos, genres, and pictures connections.
Fields
- metadata OndemandpageMetadataConnectionsMetadata -
vimeo: OndemandpageMetadataConnectionsMetadata
Fields
- connections OndemandpageMetadataConnectionsMetadataConnections -
vimeo: OndemandpageMetadataConnectionsMetadataConnections
Fields
- comments OndemandpageMetadataConnectionsMetadataConnectionsComments - Information about the comments associated with this page.
- genres OndemandpageMetadataConnectionsMetadataConnectionsGenres - Information about the genres associated with this page.
- likes OndemandpageMetadataConnectionsMetadataConnectionsLikes - Information about the likes associated with this page.
- pictures OndemandpageMetadataConnectionsMetadataConnectionsPictures - Information about the pictures associated with this page.
- seasons OndemandpageMetadataConnectionsMetadataConnectionsSeasons - Information about the seasons associated with this page.
- videos OndemandpageMetadataConnectionsMetadataConnectionsVideos - Information about the videos associated with this page.
vimeo: OndemandpageMetadataConnectionsMetadataConnectionsComments
Information about the comments associated with this page.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of comments on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: OndemandpageMetadataConnectionsMetadataConnectionsGenres
Information about the genres associated with this page.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of genres on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: OndemandpageMetadataConnectionsMetadataConnectionsLikes
Information about the likes associated with this page.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of likes on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: OndemandpageMetadataConnectionsMetadataConnectionsPictures
Information about the pictures associated with this page.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of pictures on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: OndemandpageMetadataConnectionsMetadataConnectionsSeasons
Information about the seasons associated with this page.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of seasons on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: OndemandpageMetadataConnectionsMetadataConnectionsVideos
Information about the videos associated with this page.
Fields
- extra_total decimal - The total number of extra videos.
- main_total decimal - The total number of main videos.
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of videos on this connection.
- uri string - The API URI that resolves to the connection data.
- viewable_total decimal - The total number of viewable videos.
vimeo: OndemandpagePreorder
Fields
- active boolean - Whether this page is available for preorder.
- cancel_time string - The time in ISO 8601 format when the preorder was cancelled.
- publish_time string - The time in ISO 8601 format when the preorder was released to the public.
- time string - The time in ISO 8601 format when the preorder started.
vimeo: OndemandpagePublished
Fields
- enabled boolean - Whether this On Demand page has been published.
- time string - The time in IS 8601 format when this page was published.
vimeo: OndemandPagesBody
Fields
- accepted_currencies string? - An array of accepted currencies.
Option descriptions:
AUD
- Australian DollarCAD
- Canadian DollarCHF
- Swiss FrancDKK
- Danish KroneEUR
- EuroGBP
- British PoundJPY
- Japanese YenKRW
- South Korean WonNOK
- Norwegian KronePLN
- Polish ZlotySEK
- Swedish KronaUSD
- US Dollar
- buy MeondemandpagesBuy? -
- content_rating string - One or more ratings, either as a comma-separated list or as a JSON array depending on the request format.
- description string - The description of the On Demand page.
- domain_link string? - The custom domain of the On Demand page.
- episodes MeondemandpagesEpisodes? -
- link string? - The custom string to use in this On Demand page's Vimeo URL.
- name string - The name of the On Demand page.
- rent MeondemandpagesRent? -
- subscription MeondemandpagesSubscription? -
- 'type string - The type of On Demand page.
vimeo: OndemandPagesBody1
Fields
- accepted_currencies string? - An array of accepted currencies.
Option descriptions:
AUD
- Australian DollarCAD
- Canadian DollarCHF
- Swiss FrancDKK
- Danish KroneEUR
- EuroGBP
- British PoundJPY
- Japanese YenKRW
- South Korean WonNOK
- Norwegian KronePLN
- Polish ZlotySEK
- Swedish KronaUSD
- US Dollar
- buy MeondemandpagesBuy? -
- content_rating string - One or more ratings, either as a comma-separated list or as a JSON array depending on the request format.
- description string - The description of the On Demand page.
- domain_link string? - The custom domain of the On Demand page.
- episodes MeondemandpagesEpisodes? -
- link string? - The custom string to use in this On Demand page's Vimeo URL.
- name string - The name of the On Demand page.
- rent MeondemandpagesRent? -
- subscription MeondemandpagesSubscription? -
- 'type string - The type of On Demand page.
vimeo: OndemandpagesondemandIdPreorder
Fields
- active boolean? - If set to true, you will enable pre-orders on the On Demand page.
- publish_time string? - The time that the On Demand page will be published. *Required if
preorder.active
istrue
.
vimeo: OndemandpagesondemandIdPublish
Fields
- active boolean? - Whether to publish the On Demand page.
vimeo: OndemandpagesondemandIdvideosvideoIdBuy
Fields
vimeo: OndemandpagesondemandIdvideosvideoIdBuyPrice
Fields
- AUD decimal? - The purchase price of this video in AUD.
- CAD decimal? - The purchase price of this video in CAD.
- CHF decimal? - The purchase price of this video in CHF.
- DKK decimal? - The purchase price of this video in DKK.
- EUR decimal? - The purchase price of this video in EUR.
- GBP decimal? - The purchase price of this video in GBP.
- JPY decimal? - The purchase price of this video in JPY.
- KRW decimal? - The purchase price of this video in KRW.
- NOK decimal? - The purchase price of this video in NOK.
- PLN decimal? - The purchase price of this video in PLN.
- SEK decimal? - The purchase price of this video in SEK.
- USD decimal? - The purchase price of this video in USD. *Required if
buy.active
is true.
vimeo: OndemandpagesondemandIdvideosvideoIdRent
Fields
vimeo: OndemandpagesondemandIdvideosvideoIdRentPrice
Fields
- AUD decimal? - The rental price of this video in AUD.
- CAD decimal? - The rental price of this video in CAD.
- CHF decimal? - The rental price of this video in CHF.
- DKK decimal? - The rental price of this video in DKK.
- EUR decimal? - The rental price of this video in EUR.
- GBP decimal? - The rental price of this video in GBP.
- JPY decimal? - The rental price of this video in JPY.
- KRW decimal? - The rental price of this video in KRW.
- NOK decimal? - The rental price of this video in NOK.
- PLN decimal? - The rental price of this video in PLN.
- SEK decimal? - The rental price of this video in SEK.
- USD decimal? - The rental price of this video in USD. *Required if
rent.active
is true.
vimeo: OndemandpageSubscription
Information about subscribing to this On Demand page, if enabled.
Fields
- active boolean - Whether this product is active.
- link string - The link to this product on Vimeo.
- period string? - The product's rental period.
- price record {} - The accepted currencies and respective pricing for this product.
vimeo: OnDemandPromotion
Fields
- access_type string - The type of access that this promotion grants:
Option descriptions:
default
- Grants discounts on existing product offerings.vip
- Grants free access either to VOD content before it is released or to access types that aren't part of the existing product offerings.
- discount_type string - The type of discount for which this promotion can be used.
Option descriptions:
dollars
- The discount is a certain fixed amount.free
- The discount is the full purchase price. VIP access promotions always use this discount type.percent
- The discount is a certain percentage of the full price.
- download boolean - Whether this promotion grants download access to On Demand content.
- label string - The prefix string for batch codes, or the null value for single codes.
- metadata OndemandpromotionMetadata - The video's metadata.
- percent_off decimal - The percentage amount that is deducted from the product price.
- product_type string - The type of product to which this promotion can be applied. Only
buy
andrent
are available for the VIP access type: Option descriptions:any
- The promotion can be applied to any product.buy
- The promotion can be applied to a buyable single video.buy_episode
- The promotion can be applied to a buyable single episode.rent
- The promotion can be applied to a rentable single video.rent_episode
- The promotion can be applied to a rentable single episode.subscribe
- The promotion can be applied to a subscription.
- stream_period string - The amount of time that the user has access to the VOD content after redeeming a promo code.
Option descriptions:
1_week
- Access lasts for one week.1_year
- Access lasts for one year.24_hour
- Access lasts for 24 hours.30_days
- Access lasts for 30 days.3_month
- Access lasts for 3 months.48_hour
- Access lasts for 48 hours.6_month
- Access lasts for 6 months.72_hour
- Access lasts for 72 hours.
- total decimal - The total amount of times that this promotion can be used.
- 'type string - The way in which this promotion can generate promo codes:
Option descriptions:
batch
- Provides many unique promo codes that can only be used once each.batch_prefix
- Similar tobatch
, except that all codes have a similar prefix string. This mode is deprecated, yet it may still appear for some users.single
- Provides a single promo code with many uses.
- uri string - The promotion's canonical relative URI.
vimeo: OnDemandPromotionCode
Fields
- code string - A promotion code that can be redeemed on Vimeo.
- link string - A link to redeem the promotion code instantly.
- max_uses decimal - The total amount of times this code can be used.
- uses decimal - The number of times that this code has been used.
vimeo: OndemandpromotionMetadata
The video's metadata.
Fields
- connections OndemandpromotionMetadataConnections - A list of resource URIs related to the On Demand promotion.
vimeo: OndemandpromotionMetadataConnections
A list of resource URIs related to the On Demand promotion.
Fields
- codes OndemandpromotionMetadataConnectionsCodes - Information about the codes associated with this promotion.
vimeo: OndemandpromotionMetadataConnectionsCodes
Information about the codes associated with this promotion.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of uses on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: OnDemandRegion
Fields
- country_code string - The ISO 3166-1 alpha-2 code for this country.
- country_name string - The descriptive name of this country.
- uri string - The region container's relative URI.
vimeo: OnDemandSeason
Fields
- description string - The description for this season.
- metadata OndemandseasonMetadata -
- name string - The descriptive name of the season.
- position decimal - The position of the season relative to other seasons in the series.
- resource_key string - The unique identifier for this On Demand season.
- 'type string - The type of season.
- uri string - The season container's relative URI.
- user record {} - The creator of this On Demand page.
vimeo: OndemandseasonMetadata
Fields
- connections OndemandseasonMetadataConnections -
vimeo: OndemandseasonMetadataConnections
Fields
- videos OndemandseasonMetadataConnectionsVideos - The Videos connection.
vimeo: OndemandseasonMetadataConnectionsVideos
The Videos connection.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of videos on this connection.
- uri string - The API URI that resolves to the connection ∂data.
vimeo: OnDemandVideo
Fields
- buy OndemandvideoBuy - Information about purchasing this video.
- description string? - Description of the On Demand video.
- duration string? - The duration of the On Demand video.
- episode decimal? - The episode number of the On Demand video.
- interactions OndemandvideoInteractions - An object containing information about how the authenticated user can interact with this On Demand page.
- link string - The link to this video on Vimeo.
- metadata OndemandvideoMetadata - Metadata information about this video.
- name string? - The title of the On Demand video.
- options string[]? - An array of HTTP methods permitted on this URI.
- pictures record {}? - The active picture for this video.
- play_progress decimal - The user's most recent play position in seconds for this video.
- position decimal? - Describes the manual position of this video relative to the other videos owned by this On Demand page.
- release_date string? - The time in ISO 8601 format when the On Demand video was created or published.
- release_year decimal - The year that this On Demand video was released.
- rent OndemandvideoRent - Information about renting this video.
- 'type string - The type of the On Demand video:
Option descriptions:
extra
- The On Demand video is an extra feature.main
- The On Demand video is a main feature.trailer
- The On Demand video is a trailer.
- uri string - The video container's relative URI.
- user record {}? - The owner of the video.
vimeo: OndemandvideoBuy
Information about purchasing this video.
Fields
- active boolean - Whether this On Demand video can be purchased.
- price record {} - A map of currency type to price.
- purchased boolean? - Whether this On Demand video has been purchased.
vimeo: OndemandvideoInteractions
An object containing information about how the authenticated user can interact with this On Demand page.
Fields
- page OndemandvideoInteractionsPage - Information about how the authenticated user can interact with the connection to the video's On Demand page.
vimeo: OndemandvideoInteractionsPage
Information about how the authenticated user can interact with the connection to the video's On Demand page.
Fields
- added boolean - Whether this On Demand page was added.
- options string[] - An array of HTTP methods permitted on this URI.
- uri string - The URI to access the On Demand page.
vimeo: OndemandvideoMetadata
Metadata information about this video.
Fields
- connections OndemandvideoMetadataConnections -
- interactions OndemandvideoMetadataInteractions -
vimeo: OndemandvideoMetadataConnections
Fields
- season OndemandvideoMetadataConnectionsSeason - Information about this season.
vimeo: OndemandvideoMetadataConnectionsSeason
Information about this season.
Fields
- name string - The name of the season on this connection.
- options string[] - An array of HTTP methods permitted on this URI.
- uri string - The API URI that resolves to the connection data.
vimeo: OndemandvideoMetadataInteractions
Fields
- likes OndemandvideoMetadataInteractionsLikes - Information about the user's Like interactions with this video.
- watchlater OndemandvideoMetadataInteractionsWatchlater - Information about the user's Watch Later interactions with this video.
vimeo: OndemandvideoMetadataInteractionsLikes
Information about the user's Like interactions with this video.
Fields
- added boolean - Whether the user has liked this video.
- added_time string - The time in ISO 8601 format when the user liked this video.
- uri string - The URI for the user to like this video.
vimeo: OndemandvideoMetadataInteractionsWatchlater
Information about the user's Watch Later interactions with this video.
Fields
- added boolean - Whether the user has added this video to their Watch Later queue.
- added_time string - The time in ISO 8601 format when the user added this video to their Watch Later queue.
- uri string - The URI for the user to add this video to their Watch Later queue.
vimeo: OndemandvideoRent
Information about renting this video.
Fields
- active boolean - Whether this On Demand video can be rented.
- price record {} - A map of currency type to price.
- purchased boolean? - Whether this On Demand video has been rented.
vimeo: PagesOndemandIdBody
Fields
- link string? - The custom string to use in this On Demand page's Vimeo URL.
- preorder OndemandpagesondemandIdPreorder? -
- publish OndemandpagesondemandIdPublish? -
- publish_when_ready boolean? - Whether to publish the On Demand page automatically after all videos are finished transcoding.
vimeo: Picture
Fields
- active boolean - Whether this picture is the active picture for its parent resource.
- link string? - The upload URL for the picture. This field appears when you create the picture resource for the first time.
- resource_key string - The picture's resource key string.
- sizes PictureSizes[] - An array containing reference information about all available image files.
- 'type string - The type of the picture:
Option descriptions:
caution
- An image that is appropriate for all ages.custom
- A custom image for the video.default
- The default image for the video.
- uri string - The picture's URI.
vimeo: PictureSizes
Fields
- height decimal - The height of the image.
- link string - The direct link to the image.
- link_with_play_button string? - The direct link to the image with a play button overlay.
- width decimal - The width of the image.
vimeo: PicturesPictureIdBody
Fields
- active boolean? - Whether this thumbnail is the default.
vimeo: PicturesPortraitsetIdBody
Fields
- active boolean? - Whether the picture is the user's active portrait.
vimeo: PicturesPortraitsetIdBody1
Fields
- active boolean? - Whether the picture is the user's active portrait.
vimeo: PicturesPosterIdBody
Fields
- active boolean? - Whether to make this picture the active picture.
vimeo: Play
Fields
- progressive PlayProgressive[]? - Progressive files.
- status string - The play status of the video:
Option descriptions:
playable
- The video is playable.purchase_required
- The video must be purchased.restricted
- Playback for the video is restricted.unavailable
- The video is unavailable.
vimeo: PlayProgressive
Fields
- created_time string - The time in ISO 8601 format when this video file was created.
- fps decimal - The FPS of the video file.
- height decimal - The height in pixels of the video.
- link string - The direct link to this video file.
- link_expiration_time string - The time in ISO 8601 format when the link to this video file expires.
- log record {}? - The URLs for logging events.
- md5 string - The MD5 hash of the video file.
- size decimal - The file size in bytes of this video.
- 'type string - The type of the video file:
Option descriptions:
source
- The video is a source file.video/mp4
- The video is in MP4 format.video/webm
- The video is in WebM format.vp6/x-video
- The video is in VP6 format.
- width decimal - The width in pixels of the video.
vimeo: Portfolio
Fields
- created_time string - The time in ISO 8601 format when the portfolio was created.
- description string - The portfolio's description.
- link string - The link to the portfolio.
- metadata PortfolioMetadata - Metadata about the album.
- modified_time string - The time in ISO 8601 format when the portfolio's data was last modified.
- name string - The display name of the portfolio.
- sort string - The default video sort order for the portfolio:
Option descriptions:
alphabetical
- The default sort order is alphabetical by name.clips
- The default sort order is video creation date.modified
- The default sort order is the order in which the videos were modified.recent
- The default sort order is the order in which the videos were added.
- uri string - The canonical relative URI of the portfolio.
vimeo: PortfolioMetadata
Metadata about the album.
Fields
- connections PortfolioMetadataConnections - A list of resource URIs related to the album.
vimeo: PortfolioMetadataConnections
A list of resource URIs related to the album.
Fields
- videos PortfolioMetadataConnectionsVideos - Information about the videos contained within this portfolio.
vimeo: PortfolioMetadataConnectionsVideos
Information about the videos contained within this portfolio.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of videos on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: Presets
Fields
- metadata PresetsMetadata - Metadata about the album.
- name string - The display name of the presets group.
- settings PresetsSettings - The contents of the presets group.
- uri string - The canonical relative URI of the presets object.
- user record {} - The owner of the preset.
vimeo: PresetsMetadata
Metadata about the album.
Fields
- connections PresetsMetadataConnections - A list of resource URIs related to the album.
vimeo: PresetsMetadataConnections
A list of resource URIs related to the album.
Fields
- videos PresetsMetadataConnectionsVideos - Information about the videos in this preset.
vimeo: PresetsMetadataConnectionsVideos
Information about the videos in this preset.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of videos on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: PresetsPresetIdBody
Fields
- outro string? - Disable the outro.
vimeo: PresetsPresetIdBody1
Fields
- outro string? - Disable the outro.
vimeo: PresetsSettings
The contents of the presets group.
Fields
- buttons PresetsSettingsButtons -
- logos PresetsSettingsLogos -
- outro PresetsSettingsOutro -
vimeo: PresetsSettingsButtons
Fields
- embed boolean - Whether the preset includes Embed button settings.
- hd boolean - Whether the preset includes HD button settings.
- like boolean - Whether the preset includes Like button settings.
- share boolean - Whether the present includes Share button settings.
- vote boolean - Whether the preset includes Vote button settings.
- watchlater boolean - Whether the preset includes Watch Later button settings.
vimeo: PresetsSettingsLogos
Fields
- custom boolean - Whether the preset includes custom logo settings.
- sticky_custom boolean - Whether the present includes sticky custom logo settings.
- vimeo boolean - Whether the preset includes Vimeo logo settings.
vimeo: PresetsSettingsOutro
Fields
- clips string? - A comma-separated list of video URIs. Present only if the type is
uploaded_clips
.
- link PresetsSettingsOutroLink? - The outro link settings. Present only if the type is
link
.
- text string? - The outro text. Present only if the type is
text
.
- 'type string - The preset outro type:
- videos string? - A comma-separated list of video URIs. Present only if type is
no idea
.
vimeo: PresetsSettingsOutroLink
The outro link settings. Present only if the type is link
.
Fields
- name string? - The name of the outro link.
- url string? - The URL of the outro link.
vimeo: PrivacyUsersBody
Fields
- users string[] - The array of either the user URIs or the user IDs to permit to view the private channel.
vimeo: Project
Fields
- created_time string - The time in ISO 8601 format when the project was created.
- metadata ProjectMetadata - The project's metadata.
- modified_time string - The time in ISO 8601 format when the project was last modified.
- name string - The name of the folder.
- resource_key string - The resource key string of the project.
- uri string - The URI of the project.
- user record {} - The owner of the project.
vimeo: ProjectMetadata
The project's metadata.
Fields
- connections ProjectMetadataConnections - A list of resource URIs related to the project.
vimeo: ProjectMetadataConnections
A list of resource URIs related to the project.
Fields
- videos ProjectMetadataConnectionsVideos - A standard connection object indicating how to get all the videos in this project.
vimeo: ProjectMetadataConnectionsVideos
A standard connection object indicating how to get all the videos in this project.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of videos on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: ProjectsProjectIdBody
Fields
- name string - The name of the project.
vimeo: ProjectsProjectIdBody1
Fields
- name string - The name of the project.
vimeo: PurchaseInteraction
Fields
- buy PurchaseinteractionBuy? - Information on purchasing this video.
- rent record {}? - Information on renting this video.
- subscribe PurchaseinteractionSubscribe? - Information on subscribing to this video.
vimeo: PurchaseinteractionBuy
Information on purchasing this video.
Fields
- drm boolean? - Whether the On Demand video for purchase has DRM.
vimeo: PurchaseinteractionSubscribe
Information on subscribing to this video.
Fields
- drm boolean? - Whether the On Demand subscription has DRM.
- expires_time string? - The time in ISO 8601 format when the On Demand video will expire.
- link string? - The URL to purchase this On Demand subscription on Vimeo.
- purchase_time string? - The time in ISO 8601 format when the On Demand was purchased.
- 'stream string? - The user's streaming access to this On Demand subscription:
Option descriptions:
available
- The On Demand subscription is available for streaming.purchased
- The On Demand subscription has been purchased.restricted
- Streaming for the On Demand subscription is restricted.unavailable
- The On Demand subscription is unavailable.
- uri string? - The On Demand subscription's product URI.
vimeo: Tag
Fields
- canonical string - The normalized canonical tag name.
- metadata TagMetadata - Metadata about the group.
- name string - The tag value.
- resource_key string - The tag's resource key string.
- uri string - The canonical relative URI of the tag.
vimeo: TagMetadata
Metadata about the group.
Fields
- connections TagMetadataConnections - A collection of information that is connected to this resource.
vimeo: TagMetadataConnections
A collection of information that is connected to this resource.
Fields
- videos TagMetadataConnectionsVideos - Information about the videos related to this tag.
vimeo: TagMetadataConnectionsVideos
Information about the videos related to this tag.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of videos on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: TextTrack
Fields
- active boolean - Whether this text track is active.
- hls_link string - The read-only URL of the text track file, intended for use with HLS playback.
- hls_link_expires_time string - The time in ISO 8601 format when the read-only HLS playback text track file expires.
- language string - The language code for this text track. To see a full list, request
/languages?filter=texttrack
.
- link string - The read-only URL of the text track file. You can upload to this link when you create it for the first time.
- link_expires_time string - The time in ISO 8601 format when the text track link expires.
- name string - The descriptive name of this text track.
- 'type string - The type of the text track:
Option descriptions:
captions
- The text track is for captions.subtitles
- The text track is for subtitles.
- uri string - The relative URI of the text track.
vimeo: TexttracksTexttrackIdBody
Fields
- active boolean? - Whether the text track is active, meaning that it appears in the player. Only one text track per language, and type, can be active.
- language string? - The language of the text track. For a full list of valid languages, use the /languages?filter=texttracks endpoint.
- name string? - The name of the text track.
- 'type string? - The text track type.
vimeo: UploadAttempt
Fields
- clip record {}? - The video to upload.
- complete_uri string? - The completion URI of the upload.
- form string? - The HTML upload form.
- ticket_id string - The ticket identifier string for the upload.
- upload_link string - The upload URL.
- uri string - The upload URI.
- user record {} - The owner of the uploaded video.
vimeo: User
Fields
- account string - The user's account type:
Option descriptions:
basic
- The user has a Vimeo Basic subscription.business
- The user has a Vimeo Business subscription.live_business
- The user has a Vimeo Business Live subscription.live_premium
- The user has a Vimeo Premium subscription.live_pro
- The user has a Vimeo PRO Live subscription.plus
- The user has a Vimeo Plus subscription.pro
- The user has a Vimeo Pro subscription.pro_unlimited
- The user has a Vimeo PRO Unlimited subscription.producer
- The user has a Vimeo Producer subscription.
- bio string - The user's bio.
- content_filter string[]? - The user's content filters:
Option descriptions:
drugs
- Drugs or alcohol use.language
- Profanity or sexually suggestive content.nudity
- Nudity.safe
- Suitable for all audiences.unrated
- No rating.violence
- Violent or graphic content.
- created_time string - The time in ISO 8601 format when the user account was created.
- email string? - The user's email address. This data requires a bearer token with the
email
scope.
- link string - The absolute URL of this user's profile page.
- location string - The user's location.
- metadata UserMetadata - The user's metadata.
- name string - The user's display name.
- pictures record {} - The active portrait of this user.
- preferences UserPreferences? -
- resource_key string - The user's resource key string.
- upload_quota UserUploadQuota - Appears only when the user has upload access and is looking at their own user record.
- uri string - The user's canonical relative URI.
- websites UserWebsites[] - The user's websites.
vimeo: UserIdAlbumsBody
Fields
- brand_color string? - The hexadecimal code for the color of the player buttons.
- description string? - The description of the album.
- hide_nav boolean? - Whether to hide Vimeo navigation when displaying the album.
- layout string? - The type of layout for presenting the album.
- name string - The name of the album.
- password string? - The album's password. Required only if privacy is
password
.
- privacy string? - The privacy level of the album.
- review_mode boolean? - Whether album videos should use the review mode URL.
- sort string? - The default sort order of the album's videos.
- theme string? - The color theme of the album.
vimeo: UserIdFollowingBody
Fields
- users string[] - An array of user URIs for the list of users to follow.
vimeo: UserIdProjectsBody
Fields
- name string - The name of the project.
vimeo: UserIdVideosBody
Fields
- content_rating string[]? - A list of values describing the content in this video. Find the full list in the /contentratings endpoint.
- description string? - The description of the video.
- embed MevideosEmbed? -
- license string? - The Creative Commons license.
- locale string? - The video's default language. For a full list of valid languages, use the /languages?filter=texttracks endpoint.
- name string? - The title of the video.
- password string? - The password. When you set
privacy.view
topassword
, you must provide the password as an additional parameter.
- privacy MevideosPrivacy? -
- ratings MevideosRatings? -
- review_page MevideosReviewPage? -
- spatial MevideosSpatial? -
- upload MevideosUpload -
vimeo: UserMetadata
The user's metadata.
Fields
- connections UserMetadataConnections - The list of resource URIs related to the user.
- interactions UserMetadataInteractions -
vimeo: UserMetadataConnections
The list of resource URIs related to the user.
Fields
- albums UserMetadataConnectionsAlbums - Information about the albums created by this user.
- appearances UserMetadataConnectionsAppearances - Information about the appearances of this user in other videos.
- block UserMetadataConnectionsBlock - Information on the users that the current user has blocked. This data requires a bearer token with the
private
scope.
- categories UserMetadataConnectionsCategories - Information about this user's followed categories.
- channels UserMetadataConnectionsChannels - Information about this user's subscribed channels.
- feed UserMetadataConnectionsFeed - Information about this user's feed.
- folders UserMetadataConnectionsFolders - Information about this user's folders.
- followers UserMetadataConnectionsFollowers - Information about the user's followers.
- following UserMetadataConnectionsFollowing - Information about the users that the current user is following.
- groups UserMetadataConnectionsGroups - Information about the groups created by this user.
- likes UserMetadataConnectionsLikes - Information about the videos that this user has liked.
- moderated_channels UserMetadataConnectionsModeratedChannels - Information about the channels that this user moderates.
- pictures UserMetadataConnectionsPictures - Information about this user's portraits.
- portfolios UserMetadataConnectionsPortfolios - Information about this user's portfolios.
- recommended_channels UserMetadataConnectionsRecommendedChannels - A collection of recommended channels for the current user to follow. This data requires a bearer token with the
private
scope.
- recommended_users UserMetadataConnectionsRecommendedUsers - A Collection of recommended users for the current user to follow. This data requires a bearer token with the
private
scope.
- shared UserMetadataConnectionsShared - Information about the videos that have been shared with this user.
- videos UserMetadataConnectionsVideos - Information about the videos uploaded by this user.
- watched_videos UserMetadataConnectionsWatchedVideos - Information about the videos that this user has watched.
- watchlater UserMetadataConnectionsWatchlater - Information about the videos that this user wants to watch later.
vimeo: UserMetadataConnectionsAlbums
Information about the albums created by this user.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of albums on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: UserMetadataConnectionsAppearances
Information about the appearances of this user in other videos.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of appearances on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: UserMetadataConnectionsBlock
Information on the users that the current user has blocked. This data requires a bearer token with the private
scope.
Fields
- options string[] - An array of HTTP methods permitted on this URI. This data requires a bearer token with the
private
scope.
- total decimal - The total number of blocked users on this connection. This data requires a bearer token with the
private
scope.
- uri string - The API URI that resolves to the connection data. This data requires a bearer token with the
private
scope.
vimeo: UserMetadataConnectionsCategories
Information about this user's followed categories.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of categories on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: UserMetadataConnectionsChannels
Information about this user's subscribed channels.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of channels on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: UserMetadataConnectionsFeed
Information about this user's feed.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- uri string - The API URI that resolves to the connection data.
vimeo: UserMetadataConnectionsFolders
Information about this user's folders.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of folders on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: UserMetadataConnectionsFollowers
Information about the user's followers.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of followers on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: UserMetadataConnectionsFollowing
Information about the users that the current user is following.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of users on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: UserMetadataConnectionsGroups
Information about the groups created by this user.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of groups on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: UserMetadataConnectionsLikes
Information about the videos that this user has liked.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of likes on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: UserMetadataConnectionsModeratedChannels
Information about the channels that this user moderates.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of channels on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: UserMetadataConnectionsPictures
Information about this user's portraits.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of pictures on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: UserMetadataConnectionsPortfolios
Information about this user's portfolios.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of portfolios on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: UserMetadataConnectionsRecommendedChannels
A collection of recommended channels for the current user to follow. This data requires a bearer token with the private
scope.
Fields
- options string[] - An array of HTTP methods permitted on this URI. This data requires a bearer token with the
private
scope.
- total decimal - The total number of channels on this connection. This data requires a bearer token with the
private
scope.
- uri string - The API URI that resolves to the connection data. This data requires a bearer token with the
private
scope.
vimeo: UserMetadataConnectionsRecommendedUsers
A Collection of recommended users for the current user to follow. This data requires a bearer token with the private
scope.
Fields
- options string[] - An array of HTTP methods permitted on this URI. This data requires a bearer token with the
private
scope.
- total decimal - The total number of users on this connection. This data requires a bearer token with the
private
scope.
- uri string - The API URI that resolves to the connection data. This data requires a bearer token with the
private
scope.
vimeo: UserMetadataConnectionsShared
Information about the videos that have been shared with this user.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of videos on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: UserMetadataConnectionsVideos
Information about the videos uploaded by this user.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of videos on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: UserMetadataConnectionsWatchedVideos
Information about the videos that this user has watched.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of videos on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: UserMetadataConnectionsWatchlater
Information about the videos that this user wants to watch later.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of videos on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: UserMetadataInteractions
Fields
- add_privacy_user UserMetadataInteractionsAddPrivacyUser? -
- block UserMetadataInteractionsBlock - Information related to the block status of this user.
- follow UserMetadataInteractionsFollow - Information related to the followed status of this user.
- report UserMetadataInteractionsReport - Information regarding where and how to report a user.
vimeo: UserMetadataInteractionsAddPrivacyUser
Fields
- options string[]? - An array of the HTTP methods permitted on this URI. This data requires a bearer token with the
private
scope.
- uri string? - The API URI that resolves to the connection data. This data requires a bearer token with the
private
scope.
vimeo: UserMetadataInteractionsBlock
Information related to the block status of this user.
Fields
- added boolean - Whether a user is blocking the current user.
- added_time string - The time in ISO 8601 format when the block occurred, or the null value if no block exists.
- options string[] - An array of the HTTP methods permitted on this URI.
- uri string - The URI to block or unblock the user.
vimeo: UserMetadataInteractionsFollow
Information related to the followed status of this user.
Fields
- added boolean - Whether a user is following the current user.
- options string[] - An array of the HTTP methods permitted on this URI.
- uri string - The URI to follow the user.
vimeo: UserMetadataInteractionsReport
Information regarding where and how to report a user.
Fields
- options string[] - An array of the HTTP methods permitted on this URI.
- reason string[] - List of valid reasons for reporting a video.
- uri string - The API URI that resolves to the connection data.
vimeo: UserPreferences
Fields
- videos UserPreferencesVideos? -
vimeo: UserPreferencesVideos
Fields
- privacy UserPreferencesVideosPrivacy? -
vimeo: UserPreferencesVideosPrivacy
Fields
- add boolean? - Whether other users can add the user's videos.
- comments string? - The user's privacy preference for comments:
Option descriptions:
anybody
- Anyone can comment on the user's videos.contacts
- Only contacts can comment on the user's videos.nobody
- No one can comment on the user's videos.
- download boolean? - Whether other users can download the user's videos.
- embed string? - The user's privacy preference for embeds:
Option descriptions:
private
- Only the user can embed their own videos.public
- Anyone can embed the user's videos.whitelist
- Only those on the whitelist can embed the user's videos.
- view string? - The user's privacy preference for views:
Option descriptions:
anybody
- Anyone can view the user's videos.contacts
- Only contacts can view the user's videos.disable
- Views are disabled for the user's videos.nobody
- No one except the user can view the user's videos.password
- Only those with the password can view the user's videos.unlisted
- Anybody can view the user's videos if they have a link.users
- Only other Vimeo members can view the user's videos.
vimeo: UsersUserIdBody
Fields
- bio string? - The user's bio.
- content_filter string[]? - A list of values describing the content in this video. Find the full list in the /contentratings endpoint. You must provide a comma-separated list if you are using a query string or an array if you are using JSON.
- link string? - The user's custom Vimeo URL slug.
- location string? - The user's location.
- name string? - The user's display name.
- password string? - The default password for all future videos that this user uploads. To use this field, the
videos.privacy.view
field must bepassword
.
- videos MeVideos? -
vimeo: UserUploadQuota
Appears only when the user has upload access and is looking at their own user record.
Fields
- lifetime UserUploadQuotaLifetime - Information about the user's lifetime upload usage.
- periodic UserUploadQuotaPeriodic - Information about the user's usage for the current period.
- space UserUploadQuotaSpace - Information about the user's upload space remaining for the current period.
vimeo: UserUploadQuotaLifetime
Information about the user's lifetime upload usage.
Fields
- free decimal - The number of bytes remaining in your lifetime maximum.
- max decimal - The total number of bytes that you can upload across the lifetime of your account.
- used decimal - The number of bytes that you've already uploaded against your lifetime limit.
vimeo: UserUploadQuotaPeriodic
Information about the user's usage for the current period.
Fields
- free decimal - The number of bytes remaining in your upload quota for the current period.
- max decimal - The total number of bytes that you can upload per period.
- reset_date string - The time in ISO 8601 format when your upload quota resets.
- used decimal - The number of bytes that you've already uploaded against your quota in the current period.
vimeo: UserUploadQuotaSpace
Information about the user's upload space remaining for the current period.
Fields
- free decimal - The number of bytes remaining in your upload quota.
- max decimal - The maximum number of bytes allotted to your upload quota.
- showing string - Whether the values of the upload_quota.space fields are for the lifetime quota or the periodic quota.
- used decimal - The number of bytes that you've already uploaded against your quota.
vimeo: UserWebsites
Fields
- description string - The website's description.
- link string - The URL of the website.
- name string - The name of the website.
vimeo: Video
Fields
- categories Category[] - The categories to which this video belongs.
- content_rating string[] - The content ratings of this video.
- context VideoContext - The context of the video's subscription, if this video is part of a subscription.
- created_time string - The time in ISO 8601 format when the video was created.
- description string - A brief explanation of the video's content.
- duration decimal - The video's duration in seconds.
- embed record {} - Information about embedding this video.
- height decimal - The video's height in pixels.
- language string - The video's primary language.
- last_user_action_event_date string? - The time in ISO 8601 format when the user last modified the video.
- license string - The Creative Commons license used for the video:
Option descriptions:
by
- Attributionby-nc
- Attribution Non-Commercialby-nc-nd
- Attribution Non-Commercial No Derivativesby-nc-sa
- Attribution Non-Commercial Share Alikeby-nd
- Attribution No Derivativesby-sa
- Attribution Share Alikecc0
- Public Domain Dedication
- link string - The link to the video.
- metadata VideoMetadata - The video's metadata.
- modified_time string - The time in ISO 8601 format when the video metadata was last modified.
- name string - The video's title.
- parent_folder record {}? - Information about the folder that contains this video.
- password string? - The privacy-enabled password to watch this video. Only users can see their own video passwords. This data requires a bearer token with the
private
scope.
- pictures record {} - The active picture for this video.
- privacy VideoPrivacy - The video's privacy setting.
- release_time string - The time in ISO 8601 format when the video was released.
- resource_key string - The resource key string of the video.
- spatial VideoSpatial - 360 spatial data.
- stats VideoStats - A collection of stats associated with this video.
- status string - The status code for the availability of the video. This field is deprecated in favor of
upload
andtranscode
. Option descriptions:available
- The video is available.quota_exceeded
- The user's quota is exceeded with this video.total_cap_exceeded
- The user has exceeded their total cap with this video.transcode_starting
- Transcoding is beginning for the video.transcoding
- Transcoding is underway for the video.transcoding_error
- There was an error in transcoding the video.unavailable
- The video is unavailable.uploading
- The video is being uploaded.uploading_error
- There was an error in uploading the video.
- tags Tag[] - An array of all tags assigned to this video.
- transcode VideoTranscode - The transcode information for a video upload.
- upload VideoUpload - The upload information for this video.
- uri string - The video's canonical relative URI.
- user record {} - The video owner.
- width decimal - The video's width in pixels.
vimeo: VideoContext
The context of the video's subscription, if this video is part of a subscription.
Fields
- action string - The contextual action:
Option descriptions:
Added to
- An Added To action.Appearance by
- An Appearance By action.Liked by
- A Liked By action.Uploaded by
- An Unloaded By action.
- 'resource record {} - The contextual resource: a user, group, or channel representation, or an object of a tag.
- resource_type string - The contextual resource type.
vimeo: VideoIdCategoriesBody
Fields
- category string[] - The array of the names of the categories that you're suggesting.
vimeo: VideoIdCommentsBody
Fields
- text string - The text of the comment.
vimeo: VideoIdCommentsBody1
Fields
- text string - The text of the comment.
vimeo: VideoIdCreditsBody
Fields
- email string - The email address of the credited person.
- name string - The name of the credited person.
- role string - The role of the credited person.
- user_uri string - The URI of the Vimeo user who should be given credit in this video.
vimeo: VideoIdCreditsBody1
Fields
- email string - The email address of the credited person.
- name string - The name of the credited person.
- role string - The role of the credited person.
- user_uri string - The URI of the Vimeo user who should be given credit in this video.
vimeo: VideoIdPicturesBody
Fields
- active boolean? - Whether the image created by the
time
field should be the default thumbnail for the video.
- time decimal? - Creates an image of the video from the given time offset.
vimeo: VideoIdPicturesBody1
Fields
- active boolean? - Whether the image created by the
time
field should be the default thumbnail for the video.
- time decimal? - Creates an image of the video from the given time offset.
vimeo: VideoIdSetAlbumThumbnailBody
Fields
- time_code decimal? - The video frame time in seconds to use as the album thumbnail.
vimeo: VideoIdSetAlbumThumbnailBody1
Fields
- time_code decimal? - The video frame time in seconds to use as the album thumbnail.
vimeo: VideoIdTagsBody
Fields
- name string - The name of the tag to apply. See our documentation on batch requests for more information.
- page decimal? - The page number of the results to show.
- per_page decimal? - The number of items to show on each page of results, up to a maximum of 100.
vimeo: VideoIdTexttracksBody
Fields
- active boolean? - Active text tracks appear in the player and are visible to other users. Only one text track per language can be active.
- language string - The language of the text track. For a complete list of valid languages, use the /languages?filter=texttracks endpoint.
- name string - The name of the text track.
- 'type string - The type of the text track.
vimeo: VideoIdTexttracksBody1
Fields
- active boolean? - Active text tracks appear in the player and are visible to other users. Only one text track per language can be active.
- language string - The language of the text track. For a complete list of valid languages, use the /languages?filter=texttracks endpoint.
- name string - The name of the text track.
- 'type string - The type of the text track.
vimeo: VideoIdVersionsBody
Fields
- file_name string - The name of the version
- upload VideosvideoIdversionsUpload -
vimeo: VideoMetadata
The video's metadata.
Fields
- connections VideoMetadataConnections - A list of resource URIs related to the video.
- interactions VideoMetadataInteractions - A list of resource URIs related to the video.
vimeo: VideoMetadataConnections
A list of resource URIs related to the video.
Fields
- comments VideoMetadataConnectionsComments - Information about the comments on this video.
- credits VideoMetadataConnectionsCredits - Information about the users credited in this video.
- likes VideoMetadataConnectionsLikes - Information about the users who have liked this video.
- ondemand VideoMetadataConnectionsOndemand - Information about this video's ondemand data.
- pictures VideoMetadataConnectionsPictures - Information about this video's thumbnails.
- playback VideoMetadataConnectionsPlayback - The DRM playback status connection for this video.
- recommendations VideoMetadataConnectionsRecommendations - The recommendations for this video.
- related VideoMetadataConnectionsRelated - Related content for this video.
- season VideoMetadataConnectionsSeason - Information about the video's season.
- texttracks VideoMetadataConnectionsTexttracks - Information about this video's text tracks.
- trailer VideoMetadataConnectionsTrailer - Information about this video's VOD trailer.
- users_with_access VideoMetadataConnectionsUsersWithAccess - Information about the user privacy of this video, if the video privacy is
users
.
- versions VideoMetadataConnectionsVersions - Information about the versions of this video.
vimeo: VideoMetadataConnectionsComments
Information about the comments on this video.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of comments on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: VideoMetadataConnectionsCredits
Information about the users credited in this video.
Fields
- options string[]? - An array of HTTP methods permitted on this URI.
- total decimal? - The total number of users on this connection.
- uri string? - The API URI that resolves to the connection data.
vimeo: VideoMetadataConnectionsLikes
Information about the users who have liked this video.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of likes on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: VideoMetadataConnectionsOndemand
Information about this video's ondemand data.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- resource_key string - The On Demand connection resource key.
- uri string - The API URI that resolves to the connection data.
vimeo: VideoMetadataConnectionsPictures
Information about this video's thumbnails.
Fields
- options string[] - An array of HTTP methods allowed on this URI.
- total decimal - Total number of thumbnails on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: VideoMetadataConnectionsPlayback
The DRM playback status connection for this video.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- uri string - The API URI that resolves to the connection data.
vimeo: VideoMetadataConnectionsRecommendations
The recommendations for this video.
Fields
- options string[]? - An array of HTTP methods allowed on this URI.
- uri string? - The API URI that resolves to the connection data.
vimeo: VideoMetadataConnectionsRelated
Related content for this video.
Fields
- options string[]? - An array of HTTP methods allowed on this URI.
- uri string? - The API URI that resolves to the connection data.
vimeo: VideoMetadataConnectionsSeason
Information about the video's season.
Fields
- name string - The name of this season.
- options string[] - An array of HTTP methods permitted on this URI.
- uri string - The API URI that resolves to the connection data.
vimeo: VideoMetadataConnectionsTexttracks
Information about this video's text tracks.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of text tracks on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: VideoMetadataConnectionsTrailer
Information about this video's VOD trailer.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- resource_key string - The trailer connection resource key.
- uri string - The API URI that resolves to the connection data.
vimeo: VideoMetadataConnectionsUsersWithAccess
Information about the user privacy of this video, if the video privacy is users
.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of users on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: VideoMetadataConnectionsVersions
Information about the versions of this video.
Fields
- current_uri string? - The URI of the current version of the video.
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of versions on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: VideoMetadataInteractions
A list of resource URIs related to the video.
Fields
- buy VideoMetadataInteractionsBuy - The Buy interaction for a On Demand video.
- 'channel VideoMetadataInteractionsChannel - When a video is referenced by a channel URI, if the user is a moderator of the channel, include information about removing the video from the channel.
- like VideoMetadataInteractionsLike - Information about whether the authenticated user has liked this video.
- rent VideoMetadataInteractionsRent - The Rent interaction for an On Demand video.
- report VideoMetadataInteractionsReport - Information about where and how to report a video.
- subscribe VideoMetadataInteractionsSubscribe? - Subscription information for an On Demand video.
- watched VideoMetadataInteractionsWatched - Information about removing this video from the user's list of watched videos.
- watchlater VideoMetadataInteractionsWatchlater - Information about whether this video appears on the authenticated user's Watch Later list.
vimeo: VideoMetadataInteractionsBuy
The Buy interaction for a On Demand video.
Fields
- currency string - The currency code for the current user's region.
- display_price string - Formatted price to display to buy an On Demand video.
- download string - The user's download access to this On Demand video:
Option descriptions:
available
- The video is available for download.purchased
- The user has purchased the video.restricted
- The user isn't permitted to download the video.unavailable
- The video isn't available for download.
- drm boolean - Whether the video has DRM.
- link string - The URL to buy the On Demand video on Vimeo.
- price decimal - The numeric value of the price for buying the On Demand video.
- purchase_time string - The time in ISO 8601 format when the On Demand video was purchased.
- 'stream string - The user's streaming access to this On Demand video:
Option descriptions:
available
- The video is available for streaming.purchased
- The user has purchased the video.restricted
- The user isn't permitted to stream the video.unavailable
- The video isn't available for streaming
- uri string - The product URI to purchase the On Demand video.
vimeo: VideoMetadataInteractionsChannel
When a video is referenced by a channel URI, if the user is a moderator of the channel, include information about removing the video from the channel.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- uri string - The API URI that resolves to the connection data.
vimeo: VideoMetadataInteractionsLike
Information about whether the authenticated user has liked this video.
Fields
- added boolean - Whether the user has liked the video.
- added_time string - The time in ISO 8601 format when the user liked the video.
- options string[] - An array of HTTP methods permitted on this URI.
- uri string - The API URI that resolves to the connection data.
vimeo: VideoMetadataInteractionsRent
The Rent interaction for an On Demand video.
Fields
- currency string - The currency code for the current user's region.
- display_price string - Formatted price to display to rent an On Demand video.
- drm boolean - Whether the video has DRM.
- expires_time string - The time in ISO 8601 format when the rental period for the video expires.
- link string - The URL to rent the On Demand video on Vimeo.
- price decimal - The numeric value of the price for buying the On Demand video.
- purchase_time string - The time in ISO 8601 format when the On Demand video was rented.
- 'stream string - The user's streaming access to this On Demand video:
Option descriptions:
available
- The video is available for streaming.purchased
- The user has purchased the video.restricted
- The user isn't permitted to stream the video.unavailable
- The video isn't available for streaming.
- uri string - The product URI to rent the On Demand video.
vimeo: VideoMetadataInteractionsReport
Information about where and how to report a video.
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- reason string[] - A list of valid reasons for reporting a video.
- uri string - The API URI that resolves to the connection data.
vimeo: VideoMetadataInteractionsSubscribe
Subscription information for an On Demand video.
Fields
- drm boolean? - Whether the video has DRM.
- expires_time string? - The time in ISO 8601 format when the subscription expires.
- purchase_time string? - The tine in ISO 8601 format when the subscription was purchased.
- 'stream string? - The stream type.
vimeo: VideoMetadataInteractionsWatched
Information about removing this video from the user's list of watched videos.
Fields
- added boolean - Whether the user has watched the video.
- added_time string - The time in ISO 8601 format when the user watched the video.
- options string[] - An array of HTTP methods permitted on this URI.
- uri string - The API URI that resolves to the connection data.
vimeo: VideoMetadataInteractionsWatchlater
Information about whether this video appears on the authenticated user's Watch Later list.
Fields
- added boolean - Whether the user has added the video to their Watch later list.
- added_time string - The time in ISO 8601 format when the user added the video to their Watch Later list.
- options string[] - An array of HTTP methods permitted on this URI.
- uri string - The API URI that resolves to the connection data.
vimeo: VideoPrivacy
The video's privacy setting.
Fields
- add boolean - Whether the video can be added to collections.
- comments string - Who can comment on the video:
Option descriptions:
anybody
- Anyone can comment on the video.contacts
- Only contacts can comment on the video.nobody
- No one can comment on the video.
- download boolean - The video's download permission setting.
- embed string - The video's embed permission setting:
Option descriptions:
private
- The video is private.public
- Anyone can embed the video.
- view string - The general privacy setting for the video:
Option descriptions:
anybody
- Anyone can view the video.contacts
- Only contacts can view the video.disable
- Hide from vimeonobody
- No one besides the owner can view the video.password
- Anyone with the video's password can view the video.unlisted
- Not searchable from vimeo.comusers
- Only people with a Vimeo account can view the video.
vimeo: VideoSpatial
360 spatial data.
Fields
- director_timeline VideoSpatialDirectorTimeline[] - 360 director timeline.
- field_of_view decimal - The 360 field of view, from 30 (minimum) to 90 (maximum). The default is 50.
- projection string - The 360 spatial projection:
Option descriptions:
cubical
- The spatial projection is cubical.cylindrical
- The spatial projection is cylindrical.dome
- The spatial projection is dome-shaped.equirectangular
- The spatial projection is equirectangular.pyramid
- The spatial projection is pyramid-shaped.
- stereo_format string - The 360 stereo format:
Option descriptions:
left-right
- The stereo format is left-right.mono
- The audio is monaural.top-bottom
- The stereo format is top-bottom.
vimeo: VideoSpatialDirectorTimeline
Fields
- pitch decimal? - The director timeline pitch, from -90 (minimum) to 90 (maximum).
- roll decimal? - The director timeline roll.
- time_code decimal? - The director timeline time code.
- yaw decimal? - The director timeline yaw, from 0 (minimum) to 360 (maximum).
vimeo: VideoStats
A collection of stats associated with this video.
Fields
- plays decimal - The current total number of times that the video has been played.
vimeo: VideosVideoIdBody
Fields
- position decimal? - The position of this video in the On Demand collection.
- release_year decimal? - The video release year.
- 'type string - The type of video that you are adding to the On Demand page.
vimeo: VideosVideoIdBody1
Fields
- content_rating string[]? - A list of values describing the content in this video. You can find the full list in the
/contentratings
endpoint.
- description string? - The new description of the video.
- embed MevideosEmbed? -
- license string? - The Creative Commons license.
- locale string? - The video's default language. For a full list of valid languages, use the /languages?filter=texttracks endpoint.
- name string? - The new title for the video.
- password string? - The password. When you set
privacy.view
topassword
, you must provide the password as an additional parameter.
- privacy VideosvideoIdPrivacy? -
- ratings MevideosRatings? -
- review_page MevideosReviewPage? -
- spatial MevideosSpatial? -
vimeo: VideosvideoIdPrivacy
Fields
- add boolean? - Whether a user can add the video to an album, channel, or group.
- comments string? - The privacy level required to comment on the video.
- download boolean? - Whether a user can download the video. Not available to users with a Basic membership.
- embed string? - The video's new embed settings. The
whitelist
value enables you to define all valid embed domains. See our documentation for details on adding and removing domains.
- view string? - The video's new privacy setting. When privacy is
users
,application/json
is the only valid content type. Basic users can't set privacy tounlisted
.
vimeo: VideosvideoIdversionsUpload
Fields
- approach string - Upload approach
- link string? - If your upload approach is pull, Vimeo will download the video hosted at this public URL. This URL must be valid for at least 24 hours.
- redirect_url string? - The app's redirect URL. Use this parameter when
approach
ispost
.
- size string? - Upload size
vimeo: VideoTranscode
The transcode information for a video upload.
Fields
- status string? - Status code for this video's availability.
vimeo: VideoUpload
The upload information for this video.
Fields
- approach string? - The approach for uploading the video.
- complete_uri string? - The URI for completing the upload.
- form string? - The HTML form for uploading a video through the post approach.
- link string? - The link of the video to capture through the pull approach.
- redirect_url string? - The redirect URL for the upload app.
- size decimal? - The file size in bytes of the uploaded video.
- status string - The status code for the availability of the uploaded video:
Option descriptions:
complete
- The upload is complete.error
- The upload ended with an error.in_progress
- The upload is underway.
- upload_link string? - The link for sending video file data.
vimeo: VideoVersions
Fields
- active boolean - Whether this video version is the currently active one.
- app record {} - The API app associated with the video version.
- created_time string - The time in ISO 8601 for when the video version was created.
- duration decimal - The duration of the video version in seconds.
- filename string - The file name of the video version.
- filesize decimal - The size in byes of the video version file.
- metadata VideoversionsMetadata - The video version's metadata.
- modified_time string - The time in ISO 8601 format when the video version was last modified.
- play record {} - The Play representation.
- upload VideoversionsUpload - The upload information for this version.
- upload_date string - The time in ISO 8601 format when the video version was uploaded.
- uri string - The version's canonical relative URI.
- user record {} - The owner of the video version.
vimeo: VideoversionsMetadata
The video version's metadata.
Fields
- connections VideoversionsMetadataConnections -
vimeo: VideoversionsMetadataConnections
Fields
- video VideoversionsMetadataConnectionsVideo - Data from video associated with version
vimeo: VideoversionsMetadataConnectionsVideo
Data from video associated with version
Fields
- options string[] - An array of HTTP methods permitted on this URI.
- total decimal - The total number of videos on this connection.
- uri string - The API URI that resolves to the connection data.
vimeo: VideoversionsUpload
The upload information for this version.
Fields
- approach string? - The approach for uploading the video.
- complete_uri string? - The URI for completing the upload.
- form string? - The HTML form for uploading a video through the post approach.
- link string? - The link of the video to capture through the pull approach.
- redirect_url string? - The redirect URL for the upload app.
- size decimal? - The file size in bytes of the uploaded video.
- status string - The status code for the availability of the uploaded video:
Option descriptions:
complete
- The upload is complete.error
- The upload ended with an error.in_progress
- The upload is underway.
- upload_link string? - The link for sending video file data.
Import
import ballerinax/vimeo;
Metadata
Released date: almost 3 years ago
Version: 1.1.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: slbeta6
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Content & Files/Video & Audio
Cost/Freemium
Contributors
Dependencies