{ "openapi": "3.0.1", "info": { "title": "YouTube Metrics Scraper - Videos, Shorts & Channels", "description": "Collect public metrics for YouTube videos, Shorts, live posts, and channel uploads. Get views, likes, comments, remixes, channel IDs, handles, publish dates, subscriber counts, and status fields.", "version": "1.0", "x-build-id": "1lxNU76WV5TXwkmUi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/chronometrica~youtube-metrics-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-chronometrica-youtube-metrics-scraper", "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/chronometrica~youtube-metrics-scraper/runs": { "post": { "operationId": "runs-sync-chronometrica-youtube-metrics-scraper", "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/chronometrica~youtube-metrics-scraper/run-sync": { "post": { "operationId": "run-sync-chronometrica-youtube-metrics-scraper", "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", "properties": { "startUrls": { "title": "YouTube post or channel URLs", "minItems": 0, "uniqueItems": true, "type": "array", "description": "Paste YouTube video URLs, Shorts URLs, video IDs, channel URLs, channel IDs, or @handles. Direct posts become metric rows. Channel inputs discover public posts first, then collect the same metrics.", "items": { "type": "string", "pattern": "^\\s*\\S[\\s\\S]*$" }, "default": [] }, "maxItems": { "title": "Rows to collect", "minimum": 1, "type": "integer", "description": "Maximum metric rows across direct post URLs and posts discovered from channels.", "default": 100 }, "maxItemsPerChannel": { "title": "Posts per channel", "minimum": 1, "type": "integer", "description": "Maximum public posts to discover from each channel input before collecting metrics. The total row cap still applies across all inputs.", "default": 25 }, "channelSort": { "title": "Channel post order", "enum": [ "recent", "popular", "oldest" ], "type": "string", "description": "Choose the public channel discovery order.", "default": "recent" }, "publishedAfter": { "title": "Published on or after", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only keep discovered channel posts published on or after this YYYY-MM-DD date.", "default": "" }, "publishedBefore": { "title": "Published on or before", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only keep discovered channel posts published on or before this YYYY-MM-DD date.", "default": "" }, "maxAgeDays": { "title": "Only last N days", "minimum": 1, "type": "integer", "description": "Only keep discovered channel posts from the last N days. This combines with Published on or after by using the newer lower-bound date." }, "titleIncludes": { "title": "Title contains", "type": "array", "description": "Only keep discovered channel posts whose public title contains at least one of these phrases.", "items": { "type": "string" }, "default": [] }, "titleExcludes": { "title": "Title does not contain", "type": "array", "description": "Skip discovered channel posts whose public title contains any of these phrases.", "items": { "type": "string" }, "default": [] }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Use Apify Proxy for public YouTube requests. The default is enabled because direct cloud requests are commonly challenged by YouTube.", "default": { "useApifyProxy": true } }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 5, "type": "integer", "description": "Maximum seconds to wait for each public YouTube request.", "default": 20 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "type": "integer", "description": "Maximum number of YouTube requests to resolve at the same time.", "default": 8 }, "failOnNoMetrics": { "title": "Fail when no metrics are exposed", "type": "boolean", "description": "Fail the run if none of the input URLs expose public metrics. Individual URLs without metrics still emit rows with structured statuses.", "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 } } }, "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 } } } } } } } } } }