Developer / API

Changelog

3.4

  • The Clip representation is the new default for On Demand videos.

Added

Resources

  • The following On Demand resources have added:
    • On /ondemand/pages/{ondemand_id}/videos/{video_id}, GET requests now return a 200 OK with a Clip representation.
  • The following Videos resources have added:
    • The following parameters have been added to POST on /me/videos:
      • content_rating
      • description
      • embed.buttons.embed
      • embed.buttons.fullscreen
      • embed.buttons.hd
      • embed.buttons.like
      • embed.buttons.scaling
      • embed.buttons.share
      • embed.buttons.watchlater
      • embed.color
      • embed.logos.custom.active
      • embed.logos.custom.link
      • embed.logos.custom.sticky
      • embed.logos.vimeo
      • embed.playbar
      • embed.title.name
      • embed.title.owner
      • embed.title.portrait
      • embed.volume
      • license
      • locale
      • name
      • password
      • privacy.add
      • privacy.comments
      • privacy.download
      • privacy.embed
      • privacy.view
      • ratings.mpaa.reason
      • ratings.tv.reason
      • review_page.active
      • spatial.director_timeline
      • spatial.field_of_view
      • spatial.projection
      • spatial.stereo_format
      • upload.approach
      • upload.link
      • upload.redirect_url
      • upload.size
    • On /me/videos, POST requests now return a 201 Created with a Clip representation.
    • The following parameters have been added to POST on /users/{user_id}/videos:
      • content_rating
      • description
      • embed.buttons.embed
      • embed.buttons.fullscreen
      • embed.buttons.hd
      • embed.buttons.like
      • embed.buttons.scaling
      • embed.buttons.share
      • embed.buttons.watchlater
      • embed.color
      • embed.logos.custom.active
      • embed.logos.custom.link
      • embed.logos.custom.sticky
      • embed.logos.vimeo
      • embed.playbar
      • embed.title.name
      • embed.title.owner
      • embed.title.portrait
      • embed.volume
      • license
      • locale
      • name
      • password
      • privacy.add
      • privacy.comments
      • privacy.download
      • privacy.embed
      • privacy.view
      • ratings.mpaa.reason
      • ratings.tv.reason
      • review_page.active
      • spatial.director_timeline
      • spatial.field_of_view
      • spatial.projection
      • spatial.stereo_format
      • upload.approach
      • upload.link
      • upload.redirect_url
      • upload.size
    • On /users/{user_id}/videos, POST requests now return a 201 Created with a Clip representation.

Changed

Resources

  • The following Videos resources have changed:
    • On /me/videos, POST requests now return a application/vnd.vimeo.video Content-Type header.
    • On /users/{user_id}/videos, POST requests now return a application/vnd.vimeo.video Content-Type header.

Removed

Resources

  • The following Videos resources have removed:
    • The following parameters have been removed from POST on /me/videos:
      • link
      • redirect_url
      • type
    • On /me/videos, POST requests no longer return a 201 Created with a Upload Ticket representation.
    • The following parameters have been removed from POST on /users/{user_id}/videos:
      • link
      • redirect_url
      • type
    • On /users/{user_id}/videos, POST requests no longer return a 201 Created with a Upload Ticket representation.

3.3.11

  • GET /users/{user_id}/tickets/{ticket} now returns a full Upload Ticket representation if the ticket exists.

Added

Resources

  • The following Users resources have added:
    • On /users/{user_id}/uploads/{upload}, GET requests now return a 200 OK with a Upload Attempt representation.
    • On /users/{user_id}/tickets/{ticket}, GET requests now return a 200 OK with a Upload Ticket representation.

Removed

Resources

  • The following Users resources have removed:
    • On /users/{user_id}/uploads/{upload}, GET requests no longer return a 204 No Content with a Upload Ticket representation.
    • GET on /users/{user_id}/tickets/{ticket} no longer returns a 204 No Content.

3.3.8

  • Deprecated metadata.connections.activities in the User representation.

Removed

Representations

  • The User representation has removed the following fields:
    • metadata.connections.activities
    • metadata.connections.activities.options
    • metadata.connections.activities.total
    • metadata.connections.activities.uri

3.3.6

  • In the Clip representation, review_link is removed in favor of review_page. The review page link can still be retrieved through review_page.link.

Added

Resources

  • The following Videos resources have added:
    • A review_page.active request parameter was added to PATCH on /videos/{video_id}.

Removed

Representations

  • review_link has been removed from the Clip representation.

Resources

  • The following Videos resources have removed:
    • The review_link request parameter has been removed from PATCH requests on /videos/{video_id}.

3.3.3

Removed

Representations

  • upload_link_secure has been removed from the Upload Attempt representation.
  • upload_link_secure has been removed from the Upload Ticket representation.

3.3.1

Removed

Representations

  • link_secure has been removed from the Video File v2 representation.
  • link_secure has been removed from the Video File representation.

Resources

  • The following On Demand resources have removed:
    • On /ondemand/pages/{ondemand_id}/videos/{video_id}, GET requests no longer return a 200 OK with a On Demand Video representation.

3.3

Added

Representations

  • The Category representation has added the following fields:
    • metadata.interactions
    • metadata.interactions.follow
    • metadata.interactions.follow.added
    • metadata.interactions.follow.added_time
    • metadata.interactions.follow.uri
  • The Clip representation has added the following fields:
    • categories
    • metadata.connections.recommendations
    • metadata.connections.recommendations.options
    • metadata.connections.recommendations.total
    • metadata.connections.recommendations.uri
  • The On Demand Video representation has added the following fields:
    • metadata
    • metadata.connections.season
    • metadata.connections.season.options
    • metadata.connections.season.total
    • metadata.connections.season.uri
    • metadata.interactions.likes
    • metadata.interactions.likes.added
    • metadata.interactions.likes.added_time
    • metadata.interactions.likes.uri
    • metadata.interactions.watchlater
    • metadata.interactions.watchlater.added
    • metadata.interactions.watchlater.added_time
    • metadata.interactions.watchlater.uri
  • The On Demand Page representation has added the following fields:
    • episodes.buy.active
    • episodes.buy.price
    • metadata.connections.metadata.connections.videos.extra_total
    • metadata.connections.metadata.connections.videos.main_total
    • metadata.interactions
    • metadata.interactions.buy.drm
    • metadata.interactions.subscribe.drm
    • metadata.interactions.subscribe.link
    • metadata.interactions.subscribe.purchase_time
    • metadata.interactions.subscribe.stream
    • metadata.interactions.subscribe.uri

Resources

  • The following Groups resources have added:
    • On /groups/{group_id}/videos/{video_id}, PUT requests now return a 200 OK with a Clip representation.
  • The following Videos resources have added:
    • On /videos/{video_id}/credits, POST requests now return a 201 Created with a Credit representation.
    • On /videos/{video_id}/privacy/users/{user_id}, PUT requests now return a 200 OK with a User representation.
  • The following Tags resources have added:
    • On /videos/{video_id}/tags, PUT requests now return a 200 OK with a Tag representation.

Changed

Resources

  • The following Groups resources have changed:
    • On /groups/{group_id}/videos/{video_id}, PUT requests now return a application/vnd.vimeo.video Content-Type header.
  • The following Videos resources have changed:
    • On /videos/{video_id}/credits, POST requests now return a application/vnd.vimeo.credit Content-Type header.
    • On /videos/{video_id}/privacy/users/{user_id}, PUT requests now return a application/vnd.vimeo.user Content-Type header.
  • The following Tags resources have changed:
    • On /videos/{video_id}/tags, PUT requests now return a application/vnd.vimeo.tag Content-Type header.

Removed

Representations

  • embed_presets has been removed from the Clip representation.
  • The On Demand Page representation has removed the following fields:
    • episodes.purchase.active
    • episodes.purchase.price
    • regions
    • regions.code
    • regions.name
  • default has been removed from the Picture representation.

Resources

  • The following Groups resources have removed:
    • PUT on /groups/{group_id}/videos/{video_id} no longer returns a 204 No Content.
  • The following Videos resources have removed:
    • POST on /videos/{video_id}/credits no longer returns a 201 Created.
    • PUT on /videos/{video_id}/privacy/users/{user_id} no longer returns a 204 No Content.
  • The following Tags resources have removed:
    • PUT on /videos/{video_id}/tags no longer returns a 201 Created.

3.2

  • Many new resource connections have been added to our resource representations.
  • Before 3.2, it was hard to check if a picture was the Vimeo default (vertical color bars), or an actual thumbnail or profile picture. Now, the field "default" will hold the value true when the picture is the Vimeo default.
  • Many API calls pre 3.2 would return a 204 status code and an empty body. To reduce the necessary amount of API calls necessary in a real world application, many of those now return a 200 status code and a resource representation. One example of this is PATCH on /channels/{channel_id} will now return the full channel representation along with a 200 status code
  • All endpoints should now return the proper content-type header
  • The stats fields have been deprecated on the Album, Category, Clip and Group representations. These stats can all be found now in those representations connections within the total field.

Added

Representations

  • The Comment representation has added the following fields:
    • metadata.connections.replies
    • metadata.connections.replies.options
    • metadata.connections.replies.total
    • metadata.connections.replies.uri
  • The Picture representation has added the following fields:
    • default
    • link
  • The Portfolio representation has added the following fields:
    • metadata
    • metadata.connections
    • metadata.connections.videos
    • metadata.connections.videos.options
    • metadata.connections.videos.total
    • metadata.connections.videos.uri
  • The Presets representation has added the following fields:
    • metadata
    • metadata.connections
    • metadata.connections.videos
    • metadata.connections.videos.options
    • metadata.connections.videos.total
    • metadata.connections.videos.uri

Resources

  • The following Channels resources have added:
    • On /channels/{channel_id}, PATCH requests now return a 200 OK with a Channel representation.
    • On /channels, POST requests now return a 200 OK with a Channel representation.
  • The following Me resources have added:
    • On /me, PATCH requests now return a 200 OK with a User representation.
    • On /me/pictures/{portraitset_id}, PATCH requests now return a 200 OK with a Picture representation.
  • The following Users resources have added:
    • On /users/{user_id}, PATCH requests now return a 200 OK with a User representation.
    • On /users/{user_id}/pictures/{portraitset_id}, PATCH requests now return a 200 OK with a Picture representation.
  • The following Albums resources have added:
    • On /me/albums/{album_id}, PATCH requests now return a 200 OK with a Album representation.
    • On /me/albums, POST requests now return a 200 OK with a Album representation.
    • On /users/{user_id}/albums/{album_id}, PATCH requests now return a 200 OK with a Album representation.
    • On /users/{user_id}/albums, POST requests now return a 200 OK with a Album representation.
  • The following Videos resources have added:
    • On /videos/{video_id}, PATCH requests now return a 200 OK with a Clip representation.
    • On /videos/{video_id}/comments/{comment_id}, PATCH requests now return a 200 OK with a Comment representation.
    • On /videos/{video_id}/credits/{credit_id}, PATCH requests now return a 200 OK with a Credit representation.
    • /videos/{video_id}/pictures/{picture_id} has been added with support for the following HTTP methods:
      • GET
      • PATCH
    • /videos/{video_id}/pictures has been added with support for the following HTTP methods:
      • GET
      • POST

Changed

Resources

  • The following Channels resources have changed:
    • On /channels/{channel_id}, PATCH requests now return a application/vnd.vimeo.channel Content-Type header.
  • The following Videos resources have changed:
    • On /videos/{video_id}, PATCH requests now return a application/vnd.vimeo.video Content-Type header.
    • On /videos/{video_id}/comments/{comment_id}, PATCH requests now return a application/vnd.vimeo.comment Content-Type header.
    • On /videos/{video_id}/credits/{credit_id}, PATCH requests now return a application/vnd.vimeo.credit Content-Type header.

Removed

Representations

  • The Album representation has removed the following fields:
    • stats
    • stats.videos
  • The Category representation has removed the following fields:
    • stats
    • stats.channels
    • stats.groups
    • stats.users
    • stats.videos
  • The Clip representation has removed the following fields:
    • stats.comments
    • stats.likes
  • The Group representation has removed the following fields:
    • stats
    • stats.albums
    • stats.moderators
    • stats.topics
    • stats.users
    • stats.videos
  • sizes.type has been removed from the Picture representation.

Resources

  • The following Channels resources have removed:
    • PATCH on /channels/{channel_id} no longer returns a 204 No Content.
    • On /channels, POST requests no longer return a 201 Created with a Channel representation.
  • The following Me resources have removed:
    • On /me, PATCH requests no longer return a 204 No Content with a User representation.
    • On /me/pictures/{portraitset_id}, PATCH requests no longer return a 204 No Content with a Picture representation.
  • The following Users resources have removed:
    • On /users/{user_id}, PATCH requests no longer return a 204 No Content with a User representation.
    • On /users/{user_id}/pictures/{portraitset_id}, PATCH requests no longer return a 204 No Content with a Picture representation.
  • The following Albums resources have removed:
    • On /me/albums/{album_id}, PATCH requests no longer return a 204 No Content with a Album representation.
    • On /me/albums, POST requests no longer return a 201 Created with a Album representation.
    • On /users/{user_id}/albums/{album_id}, PATCH requests no longer return a 204 No Content with a Album representation.
    • On /users/{user_id}/albums, POST requests no longer return a 201 Created with a Album representation.
  • The following Videos resources have removed:
    • PATCH on /videos/{video_id} no longer returns a 204 No Content.
    • PATCH on /videos/{video_id}/comments/{comment_id} no longer returns a 204 No Content.
    • PATCH on /videos/{video_id}/credits/{credit_id} no longer returns a 204 No Content.

3.1

Added

Representations

  • header has been added to the Channel representation.
  • header has been added to the Group representation.

Resources

  • The following On Demand resources have added:
    • /ondemand/pages/{ondemand_id}/pictures/{poster_id} has been added with support for the following HTTP methods:
      • GET
      • PATCH
    • /ondemand/pages/{ondemand_id}/pictures has been added with support for the following HTTP methods:
      • GET
      • POST
  • The following Me resources have added:
    • On /me/feed, GET requests now return a 200 OK with a Activity 3.1 representation.
    • On /me/pictures, POST requests now return a 200 OK with a Picture representation.
  • The following Users resources have added:
    • On /users/{user_id}/feed, GET requests now return a 200 OK with a Activity 3.1 representation.
    • On /users/{user_id}/pictures, POST requests now return a 200 OK with a Picture representation.

Changed

Resources

  • The following Me resources have changed:
    • On /me/feed, GET requests now return a application/vnd.vimeo.activity Content-Type header.
    • On /me/pictures, POST requests now return a application/vnd.vimeo.picture Content-Type header.
  • The following Users resources have changed:
    • On /users/{user_id}/feed, GET requests now return a application/vnd.vimeo.activity Content-Type header.
    • On /users/{user_id}/pictures, POST requests now return a application/vnd.vimeo.picture Content-Type header.

Removed

Representations

  • The Channel representation has removed the following fields:
    • stats
    • stats.users
    • stats.videos
  • location has been removed from the Picture representation.

Resources

  • The following Me resources have removed:
    • On /me/feed, GET requests no longer return a 200 OK with a Clip representation.
    • POST on /me/pictures no longer returns a 201 Created.
  • The following Users resources have removed:
    • On /users/{user_id}/feed, GET requests no longer return a 200 OK with a Clip representation.
    • POST on /users/{user_id}/pictures no longer returns a 201 Created.

3.0

Added

Representations

  • The Clip representation has added the following fields:
    • metadata.connections.comments
    • metadata.connections.comments.options
    • metadata.connections.comments.total
    • metadata.connections.comments.uri
    • metadata.connections.pictures
    • metadata.connections.pictures.options
    • metadata.connections.pictures.total
    • metadata.connections.pictures.uri
  • location has been added to the Picture representation.
  • content_filter has been added to the User representation.

Send Feedback