{ "openapi": "3.0.1", "info": { "title": "Review Scraper", "description": "Aggregate customer reviews from multiple platforms into a single unified dataset for comprehensive reputation management.\nGoogle Maps, Yelp, Facebook, BBB - Better Business Bureau, TripAdvisor, Trustpilot, Angi, Healthgrades, Avvo & OpenTable supported.", "version": "2.1", "x-build-id": "aFB7m48SNn68IJrq9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~review-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-review-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/alizarin_refrigerator-owner~review-scraper/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-review-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/alizarin_refrigerator-owner~review-scraper/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-review-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": { "businessName": { "title": "Business Name", "type": "string", "description": "Name of the business to scrape reviews for" }, "location": { "title": "Location", "type": "string", "description": "City, State or full address (used for searching)" }, "googleMapsUrl": { "title": "Google Maps URL (Optional)", "type": "string", "description": "Direct Google Maps URL for the business" }, "yelpUrl": { "title": "Yelp URL (Optional)", "type": "string", "description": "Direct Yelp business page URL" }, "facebookUrl": { "title": "Facebook Page URL (Optional)", "type": "string", "description": "Direct Facebook business page URL (required for Facebook reviews)" }, "bbbUrl": { "title": "BBB URL (Optional)", "type": "string", "description": "Direct BBB business profile URL" }, "tripAdvisorUrl": { "title": "TripAdvisor URL (Optional)", "type": "string", "description": "Direct TripAdvisor business URL" }, "platforms": { "title": "Platforms to Scrape", "type": "array", "description": "Select which review platforms to include", "items": { "type": "string", "enum": [ "google", "yelp", "facebook", "bbb", "tripadvisor", "trustpilot", "angieslist" ] }, "default": [ "google", "yelp", "facebook", "bbb" ] }, "maxReviewsPerPlatform": { "title": "Max Reviews Per Platform", "minimum": 10, "maximum": 200, "type": "integer", "description": "Maximum number of reviews to scrape from each platform", "default": 50 }, "includeResponses": { "title": "Include Owner Responses", "type": "boolean", "description": "Include business responses to reviews when available", "default": true }, "minRating": { "title": "Minimum Rating (Filter)", "minimum": 1, "maximum": 5, "type": "number", "description": "Only include reviews with this rating or higher" }, "maxRating": { "title": "Maximum Rating (Filter)", "minimum": 1, "maximum": 5, "type": "number", "description": "Only include reviews with this rating or lower (useful for finding issues)" }, "sortBy": { "title": "Sort Results By", "enum": [ "date", "rating", "platform" ], "type": "string", "description": "How to sort the final results", "default": "date" }, "outputFormat": { "title": "Output Format", "enum": [ "combined", "by_platform" ], "type": "string", "description": "How to structure the output", "default": "combined" }, "serpApiKey": { "title": "SERP API Key (BYOK)", "type": "string", "description": "For enhanced Google review scraping via SERP API" }, "yelpApiKey": { "title": "Yelp Fusion API Key (BYOK)", "type": "string", "description": "For official Yelp data via Fusion API" }, "anthropicApiKey": { "title": "Anthropic API Key (BYOK)", "type": "string", "description": "Your Anthropic API key to enable AI-powered sentiment analysis and theme extraction. Get yours at console.anthropic.com. Leave empty to skip AI analysis." }, "enableAiSentiment": { "title": "Enable AI Sentiment Analysis", "type": "boolean", "description": "When enabled with an API key, Claude AI analyzes all reviews and provides: sentiment themes, common complaints, praise patterns, competitive insights, and actionable improvement recommendations.", "default": true }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Run with sample data to test without real scraping. Returns realistic sample output instantly.", "default": true }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "URL to POST results when scraping completes (Zapier, Make, n8n, custom endpoint)" } } }, "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 } } } } } } } } } }