{ "openapi": "3.0.1", "info": { "title": "Facebook Reviews Scraper✨", "description": "✨ Scrape Facebook reviews from usernames, Page URLs, or direct reviews links. Output includes review ID, permalink, date, recommendation status, review text, tags, likes, comments, reviewer details, nested comments, replies, page URL and ID, and source context ✨ Facebook Reviews Scraper πŸ”", "version": "1.0", "x-build-id": "Yl28xivaUf2zL7YHG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/premiumscraper~facebook-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-premiumscraper-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/premiumscraper~facebook-reviews-scraper/runs": { "post": { "operationId": "runs-sync-premiumscraper-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/premiumscraper~facebook-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-premiumscraper-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": { "username": { "title": "πŸ‘€ Facebook Username(s)", "type": "array", "description": "Enter one or more Facebook usernames such as Cristiano or copperkettleyqr.", "items": { "type": "string" } }, "facebook_urls": { "title": "πŸ”— Facebook Profile / Page / Reviews URLs", "type": "array", "description": "Public profile/page links, tab links such as /followers or /following, or direct /reviews links. URL inputs are automatically converted to the matching /reviews tab.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "max_reviews": { "title": "⭐ Maximum Reviews Per Source", "minimum": 1, "type": "integer", "description": "How many public review rows to export from each resolved /reviews tab.", "default": 10 }, "include_review_comments": { "title": "πŸ’¬ Include Review Comments", "type": "boolean", "description": "When enabled, each review row includes nested public comments when Facebook exposes them.", "default": true }, "comments_limit": { "title": "Top-Level Comments Per Review", "minimum": 1, "type": "integer", "description": "Requested number of top-level comments to collect for each review when review comment collection is enabled.", "default": 10 }, "include_comment_replies": { "title": "Include Comment Replies", "type": "boolean", "description": "When enabled, each exported review can include nested replies under returned public comments.", "default": true }, "comment_replies_limit": { "title": "Replies Per Comment", "minimum": 1, "type": "integer", "description": "Requested number of replies to fetch per review comment when reply collection is enabled.", "default": 10 }, "comment_filter": { "title": "Comment Ordering", "enum": [ "most_relevant", "newest", "all_comments" ], "type": "string", "description": "Comment ordering used while collecting comments and replies for each review. Use all_comments for maximum reply visibility.", "default": "most_relevant" }, "proxyCountry": { "title": "🌍 Proxy Country", "enum": [ "US", "GB", "AU", "CA", "DE", "FR", "NL", "IT", "ES", "SE", "NO", "DK", "FI", "BE", "AT", "CH", "IE", "PL", "PT", "CZ", "HU", "RO", "GR", "BG", "HR", "SK", "RS", "JP", "KR", "SG", "HK", "TW", "TH", "MY", "ID", "PH", "VN", "IN", "BR", "MX", "AR", "CL", "CO", "PE", "ZA", "NG", "KE", "EG", "SA", "AE", "TR", "IL", "UA", "RU", "BY" ], "type": "string", "description": "Choose the residential proxy exit country for Facebook requests. US is the recommended default for the broadest public review coverage.", "default": "US" } } }, "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 } } } } } } } } } }