{ "openapi": "3.0.1", "info": { "title": "Vimeo Channel, Creator & Video Metadata Extractor", "description": "Get Vimeo video metadata from channels, creator uploads, specific video URLs, or Staff Picks, with views, likes, comments, duration, and uploader details.", "version": "1.0", "x-build-id": "CvVs0Gux7gi2jJKSK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xyrelith-data~vimeo-channel-creator-and-video-metadata-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xyrelith-data-vimeo-channel-creator-and-video-metadata-extractor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/xyrelith-data~vimeo-channel-creator-and-video-metadata-extractor/runs": { "post": { "operationId": "runs-sync-xyrelith-data-vimeo-channel-creator-and-video-metadata-extractor", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/xyrelith-data~vimeo-channel-creator-and-video-metadata-extractor/run-sync": { "post": { "operationId": "run-sync-xyrelith-data-vimeo-channel-creator-and-video-metadata-extractor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "byChannel", "byUser", "videoDetails", "staffPicks", "search", "searchCreators", "searchChannels", "category", "tag", "showcase", "videoComments", "videoLikes" ], "type": "string", "description": "What to scrape from Vimeo. Each mode uses the matching list field below.", "default": "byChannel" }, "channelSlugs": { "title": "Channel Slugs or URLs", "type": "array", "description": "Channels to scrape in byChannel mode. Paste a slug (staffpicks) or a channel URL. maxItems applies to each channel.", "default": [ "staffpicks" ], "items": { "type": "string" } }, "usernames": { "title": "Creator Usernames or IDs", "type": "array", "description": "Creators to scrape in byUser mode. Paste a username, numeric user ID, user123 ID, or profile URL.", "default": [], "items": { "type": "string" } }, "videoUrls": { "title": "Video URLs or IDs", "type": "array", "description": "Videos for videoDetails, videoComments or videoLikes. Any public Vimeo URL form works (video, player, vanity, showcase, unlisted hash) or a numeric ID.", "default": [], "items": { "type": "string" } }, "searchQueries": { "title": "Search Queries", "type": "array", "description": "Keywords for search, searchCreators and searchChannels. Each query produces up to maxItems results.", "default": [], "items": { "type": "string" } }, "categorySlugs": { "title": "Category Slugs", "type": "array", "description": "Categories for category mode, e.g. documentary, animation, music, travel, 2d, vfx, food. Unknown slugs are skipped.", "default": [], "items": { "type": "string" } }, "tagSlugs": { "title": "Tags", "type": "array", "description": "Tags for tag mode. Enter them with or without '#', e.g. nature, timelapse, shortfilm.", "default": [], "items": { "type": "string" } }, "showcaseUrls": { "title": "Showcase URLs or IDs", "type": "array", "description": "Showcases (albums) for showcase mode. Paste a showcase URL, album URL or numeric showcase ID.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum records to return per source (channel, creator, query, category, tag, showcase or video). Search and tag results are capped by Vimeo at 10,000.", "default": 20 }, "sort": { "title": "Sort Order", "enum": [ "default", "relevance", "newest", "oldest", "mostViewed", "mostLiked", "mostCommented", "longest", "shortest", "titleAZ", "titleZA" ], "type": "string", "description": "Result order. Unsupported combinations fall back to Vimeo's default order and appear in the run status.", "default": "default" }, "filterCategory": { "title": "Search: Category", "enum": [ "any", "adsandcommercials", "animation", "brandedcontent", "comedy", "documentary", "experimental", "music", "narrative", "sports", "travel", "food", "fashion", "educational" ], "type": "string", "description": "Only used in search mode. Restricts keyword results to one category.", "default": "any" }, "filterDuration": { "title": "Search: Duration", "enum": [ "any", "short", "medium", "long" ], "type": "string", "description": "Only used in search mode. Short is under 3 minutes, medium is 3-10 minutes, long is over 10 minutes.", "default": "any" }, "filterResolution": { "title": "Search: Resolution", "enum": [ "any", "4k" ], "type": "string", "description": "Only used in search mode. Restricts results to 4K and above.", "default": "any" }, "filterPrice": { "title": "Search: Price", "enum": [ "any", "free", "paid" ], "type": "string", "description": "Only used in search mode. Free or paid (Vimeo On Demand) videos.", "default": "any" }, "filterLicense": { "title": "Search: Creative Commons License", "enum": [ "any", "cc0", "cc-by", "cc-by-sa", "cc-by-nd", "cc-by-nc", "cc-by-nc-sa", "cc-by-nc-nd" ], "type": "string", "description": "Only used in search mode. Restricts results to a Creative Commons license.", "default": "any" }, "filterUploaded": { "title": "Search: Upload Date", "enum": [ "any", "this-week", "this-month", "this-year" ], "type": "string", "description": "Only used in search mode. Restricts results to videos uploaded this week, this month or this year.", "default": "any" }, "filterStaffPicked": { "title": "Search: Staff Picks Only", "type": "boolean", "description": "Only used in search mode. Return only videos that Vimeo staff picked.", "default": false }, "filterHdr": { "title": "Search: HDR", "enum": [ "any", "anyHdr", "dolbyVision", "hdr10" ], "type": "string", "description": "Only used in search mode. Restricts results to any HDR format, Dolby Vision or HDR10.", "default": "any" }, "filterVimeo360": { "title": "Search: 360 or Spatial", "enum": [ "any", "spatial", "360" ], "type": "string", "description": "Only used in search mode. Restricts results to spatial or 360-degree videos.", "default": "any" }, "filterLive": { "title": "Search: Live Videos Only", "type": "boolean", "description": "Only used in search mode. Return only currently live videos.", "default": false }, "includeCreatorProfile": { "title": "Include Creator Profile Row", "type": "boolean", "description": "In byUser mode, emit one creator record (bio, links, followers, counts) before that creator's videos.", "default": false }, "includeChannelProfile": { "title": "Include Channel Profile Row", "type": "boolean", "description": "In byChannel and staffPicks modes, emit one channel record (description, logo, header, tags, counts) before that channel's videos.", "default": false } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }