Connecting to Vimeo

Vimeo is a professional video hosting platform. The Vimeo API uses personal access tokens (bearer tokens) to enable secure access to video metadata, user information, channels, groups, categories, and related resources.

Using API Key Authentication

To authenticate to the Vimeo API, you will need to provide a personal access token. To obtain your access token:

1. Log in to your Vimeo account at https://vimeo.com
2. Navigate to https://developer.vimeo.com/apps
3. Create a new app or select an existing app
4. Under "Personal Access Tokens", click "Generate" to create a new token
5. Select the required scopes: public and private for read access
6. Copy the generated token

After obtaining your access token, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Vimeo personal access token.

Example connection string

Profile=C:\profiles\Vimeo.apip;ProfileSettings='APIKey=your_personal_access_token';

Available Tables

The Vimeo profile provides access to the following tables:

• Videos: Vimeo videos with metadata, privacy settings, and embed configuration
• Users: Vimeo user profiles with account details and preferences
• Channels: Curated collections of videos created by users
• Groups: Community spaces where members can share and discuss videos
• Categories: Video categories used to classify and organize video content
• VideoComments: Comments posted on a specific Vimeo video (requires VideoUri)
• VideoTextTracks: Subtitle and caption text tracks for a video (requires VideoUri)
• ChannelVideos: Videos within a specific channel (requires ChannelUri)
• GroupVideos: Videos within a specific group (requires GroupUri)
• CategoryVideos: Videos within a specific category (requires CategoryUri)
• UserFollowers: Users who follow a Vimeo account
• UserFollowing: Users that a Vimeo account follows
• UserLikedVideos: Videos liked by a Vimeo user
• ContentRatings: Content rating codes used to classify video suitability
• CreativeCommons: Creative Commons license codes available for video licensing
• Languages: BCP 47 language codes supported by Vimeo
• OnDemandGenres: Genre categories for Vimeo On Demand content
• OnDemandRegions: Geographic regions supported for Vimeo On Demand distribution

Usage Examples

Videos:

SELECT * FROM Videos
SELECT * FROM Videos WHERE VideoUri = '/videos/76979871'
SELECT * FROM Videos WHERE UserUri = '/users/12345678'

Users:

SELECT * FROM Users
SELECT * FROM Users WHERE UserUri = '/users/12345678'

Channels:

SELECT * FROM Channels
SELECT * FROM Channels WHERE ChannelUri = '/channels/1959287'

VideoComments (requires VideoUri):

SELECT * FROM VideoComments WHERE VideoUri = '/videos/76979871'

VideoTextTracks (requires VideoUri):

SELECT * FROM VideoTextTracks WHERE VideoUri = '/videos/76979871'

ChannelVideos (requires ChannelUri):

SELECT * FROM ChannelVideos WHERE ChannelUri = '/channels/1959287'

GroupVideos (requires GroupUri):

SELECT * FROM GroupVideos WHERE GroupUri = '/groups/867852'

CategoryVideos (requires CategoryUri):

SELECT * FROM CategoryVideos WHERE CategoryUri = '/categories/animation'

UserFollowers:

SELECT * FROM UserFollowers
SELECT * FROM UserFollowers WHERE UserUri = '/users/12345678'

Categories:

SELECT * FROM Categories

Groups:

SELECT * FROM Groups
SELECT * FROM Groups WHERE GroupUri = '/groups/867852'

UserFollowing:

SELECT * FROM UserFollowing
SELECT * FROM UserFollowing WHERE UserUri = '/users/12345678'

UserLikedVideos:

SELECT * FROM UserLikedVideos
SELECT * FROM UserLikedVideos WHERE UserUri = '/users/12345678'

ContentRatings:

SELECT * FROM ContentRatings

CreativeCommons:

SELECT * FROM CreativeCommons

Languages:

SELECT * FROM Languages

OnDemandGenres:

SELECT * FROM OnDemandGenres

OnDemandRegions:

SELECT * FROM OnDemandRegions

Notes

• Child tables (VideoComments, VideoTextTracks, ChannelVideos, GroupVideos, CategoryVideos) require a parent URI to be specified in the WHERE clause.
• User-scoped tables (UserFollowers, UserFollowing, UserLikedVideos) default to the authenticated user when no UserUri is provided.
• The Videos table supports filtering by VideoUri (single record) or UserUri (user's videos list).
• All URI values follow the Vimeo API format, e.g., /videos/76979871, /users/123456, /channels/1959287.

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

---

Property	Description
APIKey	The personal access token used to authenticate to the Vimeo API.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT