{ "openapi": "3.0.1", "info": { "title": "Facebook Reviews Scraper", "description": "Scrape public Facebook business page reviews by URL, business name search, or Page ID. Filters by date range, keyword, recommendation status, and sort order", "version": "0.1", "x-build-id": "yB4dCJhn8Ok4LX1dz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~facebook-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-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/crawlerbros~facebook-reviews-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-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/crawlerbros~facebook-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-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": { "mode": { "title": "Input Mode", "enum": [ "url", "search", "pageId" ], "type": "string", "description": "How to specify which Facebook page to scrape reviews from.", "default": "url" }, "startUrls": { "title": "Facebook Reviews URLs", "type": "array", "description": "Links to Facebook page review sections (e.g. https://www.facebook.com/mcdonalds/reviews). Used when mode is 'Direct URL'.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQueries": { "title": "Business Search Queries", "type": "array", "description": "Business name and location to search on Facebook (e.g. 'Starbucks Dallas TX'). Used when mode is 'Business Name Search'.", "items": { "type": "string" } }, "pageIds": { "title": "Facebook Page IDs", "type": "array", "description": "Numeric Facebook Page IDs (e.g. '123456789'). Used when mode is 'Facebook Page ID'.", "items": { "type": "string" } }, "maxReviews": { "title": "Max Reviews (Global)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum total reviews to scrape across all input pages (1–500). Collection stops once this global cap is reached.", "default": 100 }, "maxReviewsPerPage": { "title": "Max Reviews Per Page", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum reviews to scrape from each individual Facebook page (1–500). Useful when scraping multiple URLs to get an even spread of reviews per page." }, "sortBy": { "title": "Sort Order", "enum": [ "most_recent", "most_helpful" ], "type": "string", "description": "Order in which to load reviews from the page.", "default": "most_recent" }, "filterByRecommendation": { "title": "Recommendation Filter", "enum": [ "all", "recommended", "not_recommended" ], "type": "string", "description": "Only return reviews with the selected recommendation status. Facebook uses binary Recommended/Not Recommended (no star ratings).", "default": "all" }, "filterByDateFrom": { "title": "Date From (YYYY-MM-DD)", "type": "string", "description": "Only return reviews posted on or after this date. Format: YYYY-MM-DD (e.g. 2024-01-01)." }, "filterByDateTo": { "title": "Date To (YYYY-MM-DD)", "type": "string", "description": "Only return reviews posted on or before this date. Format: YYYY-MM-DD (e.g. 2024-12-31)." }, "filterByKeyword": { "title": "Keyword Filter", "type": "string", "description": "Only return reviews containing this word or phrase (case-insensitive)." }, "cookies": { "title": "Facebook Cookies", "type": "array", "description": "Optional Facebook session cookies (from a logged-in browser) to unlock more reviews. Without cookies, Facebook limits results to ~10–15 per page. Use a browser extension like 'EditThisCookie' to export cookies as JSON. Each entry must have at minimum 'name', 'value', and 'domain' fields." }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for bypassing Facebook's bot detection. Recommended: use RESIDENTIAL proxy group for best results. Without proxy, Facebook may block requests from datacenter IPs." } } }, "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 } } } } } } } } } }