{ "openapi": "3.0.1", "info": { "title": "Etsy Reviews Scraper With Sentiment & Analytics", "description": "Extract customer feedback from Etsy listings using the Etsy Reviews Scraper. Collect review text, ratings, reviewer names, dates, and product details automatically. Ideal for product research, sentiment analysis, and eCommerce market insights.", "version": "0.1", "x-build-id": "QafY8FCwe2xcPciuO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~etsy-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-etsy-reviews-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/scraper-engine~etsy-reviews-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-etsy-reviews-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/scraper-engine~etsy-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-etsy-reviews-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "🔗 Shop URLs or names", "type": "array", "description": "Add Etsy shop URLs (e.g. https://www.etsy.com/shop/ShopName) or plain shop names. Add multiple shops — the actor scrapes each one and combines all reviews into a single dataset.", "items": { "type": "string" } }, "maxReviewsPerShop": { "title": "📊 Max reviews per shop", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of reviews to fetch per shop (1–5000). The actor paginates through review pages until this limit or until no more reviews are available. Default: 100.", "default": 100 }, "maxRetries": { "title": "🔁 Max retries per request", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many times to retry a review-page request before giving up on it. Default: 3.", "default": 3 }, "retryDelaySeconds": { "title": "⏱️ Retry delay (seconds)", "minimum": 1, "maximum": 60, "type": "integer", "description": "Base delay between retries, in seconds (increases with each retry attempt). Default: 5.", "default": 5 }, "includeShopAnalytics": { "title": "📊 Include shop analytics row", "type": "boolean", "description": "After each shop's reviews are collected, push one extra summary row (type=\"shopAnalytics\") with rating distribution, response rate, average review length, % of reviews with photos, and review velocity (reviews/month) computed from the reviews collected in this run. Default: enabled.", "default": true }, "enableAiAnalysis": { "title": "🤖 Enable AI review analysis", "type": "boolean", "description": "When enabled, each review's text is classified with an AI model into sentiment (positive/neutral/negative), up to 3 topics (e.g. shipping speed, item quality, sizing/fit), detected language, and a spam/fake-review signal. Off by default — requires an API key below.", "default": false }, "aiModel": { "title": "🤖 AI Model / Provider", "enum": [ "claude-haiku-4-5", "claude-sonnet-5", "claude-opus-4-8", "claude-fable-5", "gpt-4o-mini", "gpt-4o", "gpt-4.1-mini", "gpt-4.1", "o3-mini", "o1", "gemini-2.0-flash-lite", "gemini-2.0-flash", "gemini-1.5-pro", "gemini-2.5-flash", "gemini-2.5-pro", "grok-2-latest", "grok-3-mini", "grok-3", "grok-beta", "deepseek-chat", "deepseek-reasoner", "sonar", "sonar-pro", "sonar-reasoning", "mistral-small-latest", "mistral-large-latest" ], "type": "string", "description": "Only used when AI review analysis is enabled. Provider is auto-detected from the name: claude-*=Anthropic, gpt-*/o1/o3=OpenAI, gemini-*=Google, grok-*=xAI, deepseek-*=DeepSeek, sonar*=Perplexity, mistral-*=Mistral. Cheaper mini/flash/haiku models are recommended for this kind of classification.", "default": "claude-haiku-4-5" }, "aiApiKey": { "title": "🔑 AI provider API key", "type": "string", "description": "API key for the selected AI provider. Only needed when AI review analysis is enabled. Falls back to an environment variable on the account if left empty (e.g. ANTHROPIC_API_KEY, OPENAI_API_KEY, GEMINI_API_KEY)." }, "proxyConfiguration": { "title": "🌐 Proxy configuration", "type": "object", "description": "Configures the Apify Proxy used to reach Etsy. Leave the default (or empty) to use residential proxy, which this actor needs for reliable access — up to 3 retries per shop. You may select different proxy groups here and they will be used instead." } } }, "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 } } } } } } } } } }