{ "openapi": "3.0.1", "info": { "title": "Facebook Reviews Scraper - Ratings, Sentiment, No Login", "description": "Scrape public Facebook page reviews & recommendations without login. Get reviewer, rating, text, date, photos + page rating summary, AI sentiment, contact email/phone, address & GPS. Keyword search, incremental only-new, dedup, date filter. Pay per result, hard cost caps - no runaway bills.", "version": "0.1", "x-build-id": "o4weHAePbj79yV1oL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apivault_labs~facebook-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apivault_labs-facebook-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/apivault_labs~facebook-reviews-scraper/runs": { "post": { "operationId": "runs-sync-apivault_labs-facebook-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/apivault_labs~facebook-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-apivault_labs-facebook-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", "properties": { "startUrls": { "title": "Facebook Page URLs", "type": "array", "description": "Public Facebook page URLs (or //reviews/). Supports /pagename/, /profile.php?id=..., and bare numeric page IDs. Each page's reviews/recommendations are scraped.", "items": { "type": "string" } }, "searchQueries": { "title": "Keyword search (optional)", "type": "array", "description": "Optional. Business/brand keywords to discover public Facebook pages (via search engines) and scrape their reviews. Use instead of, or together with, URLs.", "items": { "type": "string" } }, "maxReviewsPerPage": { "title": "Max reviews per page", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on reviews/recommendations saved per page. Logged-out pages expose a window of recent public recommendations.", "default": 50 }, "maxResults": { "title": "Max results (cost cap)", "minimum": 0, "maximum": 50000, "type": "integer", "description": "Hard cap on total reviews scraped and billed across all pages. Protects against runaway cost. 0 = no cap.", "default": 500 }, "maxCostUsd": { "title": "Max cost USD (cost cap)", "minimum": 0, "type": "number", "description": "Hard budget in USD. The run stops once this estimated cost is reached. 0 = no budget cap.", "default": 0 }, "sinceDays": { "title": "Only reviews from last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Recency filter — keep only reviews published within the last N days. Empty = no date filter." }, "keywordFilter": { "title": "Review text keyword filter", "type": "string", "description": "Optional. Keep only reviews whose text contains this keyword (case-insensitive)." }, "onlyNewSinceLastRun": { "title": "Incremental — only new reviews", "type": "boolean", "description": "Skip reviews already returned in previous runs (state stored in a named key-value store). Great for monitoring — only brand-new reviews each run (gap feature, only 1/12).", "default": false }, "analyzeSentiment": { "title": "AI sentiment analysis", "type": "boolean", "description": "Classify each review as positive / negative / neutral with a score, and extract overall sentiment breakdown + top themes. Token-free (no LLM key needed).", "default": true }, "enrichPageContacts": { "title": "Extract page contact (email / phone)", "type": "boolean", "description": "Pull the page's public contact email, phone, website and address + GPS coordinates into the page summary — turns reviews into lead data (gap feature, only 1/12).", "default": true }, "includeMedia": { "title": "Include review photos", "type": "boolean", "description": "Include photo/image URLs attached to reviews when present.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many pages to scrape in parallel. Recommended 3-8.", "default": 5 }, "timeout": { "title": "Timeout per page (seconds)", "minimum": 15, "maximum": 180, "type": "integer", "description": "Maximum time to wait for each page fetch.", "default": 45 }, "maxRetries": { "title": "Max retries per page", "minimum": 0, "maximum": 8, "type": "integer", "description": "Retries for a blocked/failed fetch, each rotating a fresh proxy IP with backoff. 0-8.", "default": 2 }, "useResidentialProxy": { "title": "Allow residential proxy fallback (recommended)", "type": "boolean", "description": "Datacenter proxy is used first (cheap). When a page is blocked on datacenter, the Actor escalates to Apify residential proxy. Disable to stay datacenter-only.", "default": true }, "proxyCountry": { "title": "Proxy country code (geo-targeting)", "type": "string", "description": "ISO 2-letter country code (e.g. US, GB, DE). Geo-targets both proxies to get region-specific availability and avoid locale redirects. Empty = automatic.", "default": "US" }, "dedupe": { "title": "Deduplicate", "type": "boolean", "description": "Drop duplicate input pages and duplicate reviews (same review ID), so the same review is never saved or billed twice.", "default": true }, "notifyWebhookUrl": { "title": "Real-time webhook URL", "type": "string", "description": "Optional. Each scraped review is POSTed as JSON to this URL the moment it's found (Zapier / Make / n8n / Slack)." } } }, "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 } } } } } } } } } }