{ "openapi": "3.0.1", "info": { "title": "Facebook Reviews Scraper", "description": "Facebook Reviews Scraper SD - Facebook Reviews Scraper is a social media data tool that extracts public reviews (recommendations) of Facebook pages: text, recommends or not, tags, date, reviewer, reactions, comments, photos and the page rating summary, no login.", "version": "1.0", "x-build-id": "h2q46k3rMuumD6yjo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neuro-scraper~facebook-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neuro-scraper-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/neuro-scraper~facebook-reviews-scraper/runs": { "post": { "operationId": "runs-sync-neuro-scraper-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/neuro-scraper~facebook-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-neuro-scraper-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 pages", "type": "array", "description": "Page URLs, their /reviews URLs, usernames (katzsdeli) or numeric page ids, one per line.", "items": { "type": "string" } }, "maxReviewsPerPage": { "title": "Max reviews per page", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Facebook returns 3 reviews per request logged out (measured).", "default": 50 }, "onlyReviewsNewerThan": { "title": "Only reviews newer than", "type": "string", "description": "Keep reviews published on or after this date: 2026-09-01, a full ISO time, or a relative period such as \"7 days\", \"2 weeks\", \"3 months\", \"1 year\". Empty = no limit." }, "onlyReviewsOlderThan": { "title": "Only reviews older than", "type": "string", "description": "Keep reviews published on or before this date (same formats). Empty = no limit." }, "recommendation": { "title": "Recommendation", "enum": [ "all", "recommended", "not_recommended" ], "type": "string", "description": "Keep positive, negative or all reviews.", "default": "all" }, "keywords": { "title": "Review text contains", "type": "array", "description": "Keep only reviews whose text contains any of these words (one per line).", "items": { "type": "string" } }, "onlyWithText": { "title": "Only reviews with text", "type": "boolean", "description": "Skip reviews that only recommend without writing anything.", "default": false }, "maxComments": { "title": "Comments per post (0 = none)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Also read up to this many public comments of every post and attach them as \"comments\". Each comment page is one extra request (about 10 comments per request).", "default": 0 }, "commentsSort": { "title": "Comment order", "enum": [ "relevant", "newest", "oldest", "all" ], "type": "string", "description": "Order of the comments Facebook returns.", "default": "relevant" }, "maxRepliesPerComment": { "title": "Replies per comment (0 = none)", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Also read replies of each comment (nested under \"replies\").", "default": 0 }, "enrichPageContacts": { "title": "Add page contacts", "type": "boolean", "description": "Also read the page's email, phone, websites, address, category and followers (one extra request per page) into every row.", "default": false }, "onlyNewReviews": { "title": "Only reviews not delivered before", "type": "boolean", "description": "Remember delivered review ids (named key-value store \"facebook-reviews-scraper-state\") and skip them in later runs.", "default": false }, "maxPagesPerPage": { "title": "Max result pages per Facebook page", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Safety stop. Facebook returns 3 reviews per request.", "default": 2000 }, "maxTotalItems": { "title": "Max results in total (0 = no total limit)", "minimum": 0, "type": "integer", "description": "Stops the whole run after this many dataset rows (all inputs together).", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Facebook limits logged-out visitors per IP address. Residential proxies (the default) give the most reliable results; the Actor switches to a fresh IP when Facebook refuses one.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }