{ "openapi": "3.0.1", "info": { "title": "YouTube Comment Voice-of-Customer Miner", "description": "Pulls comments and replies from YouTube videos matching a brand, product, or keyword, via the official YouTube Data API v3, structured for sentiment and voice-of-customer analysis.", "version": "1.0", "x-build-id": "lOH4xZXPLipknFOfz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mibedk~youtube-comment-voc-miner/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mibedk-youtube-comment-voc-miner", "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/mibedk~youtube-comment-voc-miner/runs": { "post": { "operationId": "runs-sync-mibedk-youtube-comment-voc-miner", "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/mibedk~youtube-comment-voc-miner/run-sync": { "post": { "operationId": "run-sync-mibedk-youtube-comment-voc-miner", "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": [ "apiKey" ], "properties": { "apiKey": { "title": "YouTube Data API v3 key", "type": "string", "description": "A free Google Cloud API key with the 'YouTube Data API v3' enabled. No OAuth or login needed. Get one in ~2 minutes: console.cloud.google.com/apis/credentials -> Create Credentials -> API key, then enable 'YouTube Data API v3' for that project in the API Library. The free daily quota (10,000 units) covers roughly 1,000+ comment-list calls per day." }, "videoUrls": { "title": "Video URLs or IDs", "type": "array", "description": "Explicit YouTube videos to mine comments from. Accepts full URLs or bare 11-character video IDs. Leave empty to discover videos automatically via 'Search query' instead.", "default": [], "items": { "type": "string" } }, "searchQuery": { "title": "Search query (used only if Video URLs is empty)", "type": "string", "description": "A brand, product, or topic to search YouTube for. The actor finds the top matching videos (see 'Max videos to search') and mines comments from each. Ignored if 'Video URLs' is filled in.", "default": "iPhone 16 review" }, "keywordFilter": { "title": "Comment keyword filter (optional)", "type": "array", "description": "Only keep comments/replies containing at least one of these words or phrases (case-insensitive substring match). Leave empty to keep every comment returned by YouTube.", "default": [], "items": { "type": "string" } }, "includeReplies": { "title": "Include replies", "type": "boolean", "description": "Also fetch and return replies to top-level comments, not just the top-level comments themselves.", "default": true }, "sortOrder": { "title": "Sort order", "enum": [ "relevance", "time" ], "type": "string", "description": "'relevance' returns YouTube's top comments first (best for a quick read on sentiment). 'time' returns newest comments first (best for monitoring fresh reactions).", "default": "relevance" }, "maxItems": { "title": "Max comments/replies to return", "minimum": 1, "type": "integer", "description": "Hard cap on the total number of comment records returned and charged for across the whole run.", "default": 100 }, "maxVideos": { "title": "Max videos to search", "minimum": 1, "maximum": 50, "type": "integer", "description": "When discovering videos via 'Search query' (i.e. Video URLs is empty), how many candidate videos to pull comments from. Ignored when Video URLs is filled in.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. The actor talks directly to Google's API, not YouTube's website, so a proxy is rarely needed and the run is cheaper without one. Leave this off unless you are hitting IP-based rate limits.", "default": { "useApifyProxy": 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 } } } } } } } } } }