{ "openapi": "3.0.1", "info": { "title": "Facebook Page Posts Scraper With Engagement Analytics", "description": "Scrape Facebook page posts with text, images, reactions, comments, and timestamps. Ideal for research, analytics, content tracking, and competitor insights with clean structured output.", "version": "0.1", "x-build-id": "A1wGL5sdqyRaZBUdW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~facebook-page-posts-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-facebook-page-posts-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/scraper-engine~facebook-page-posts-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-facebook-page-posts-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/scraper-engine~facebook-page-posts-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-facebook-page-posts-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": { "pagesToAnalyze": { "title": "📘 Pages to benchmark", "type": "array", "description": "📋 Add the Facebook page links or handles you want engagement analytics for. Example: `https://www.facebook.com/RealMadrid/` or simply `RealMadrid`. Each page's recent posts become one analytics sample. (Base field `startUrls` is still accepted.)", "items": { "type": "string" } }, "postsToAnalyze": { "title": "📐 Sample size (posts per page)", "minimum": 1, "maximum": 5000, "type": "integer", "description": "🎚️ How many recent posts to score per page (1–5000). This is the window that rank, percentile and best-hour are computed over. Default 20. (Base field `maxPostsPerProfile` is still accepted.)" }, "includeReactionBreakdown": { "title": "❤️ Accurate 7-type reaction breakdown", "type": "boolean", "description": "🧮 Decode Facebook's opaque reaction ids into exact per-type totals — like, love, haha, wow, sad, angry, care — plus the dominant topReaction. Locale-independent (works on non-English pages). Default true.", "default": true }, "includeAnalytics": { "title": "📈 Derived engagement metrics", "type": "boolean", "description": "🚀 Add computed metrics per post: engagementTotal, viralityScore (engagement per hour of age), commentRate / shareRate / reactionRate, rankInResultSet, engagementPercentile, and the set's bestPostingHour (UTC). Default true.", "default": true }, "analyzeFrom": { "title": "⏱️ Analyze posts since", "type": "string", "description": "⏪ Restrict the engagement sample to posts published on or after this point — a calendar date or a relative window like “7 days” / “2 weeks”. Empty = no lower bound. (Base field `startDate` is still accepted.)" }, "analyzeUntil": { "title": "⏱️ Analyze posts until", "type": "string", "description": "⏩ Restrict the engagement sample to posts published on or before this point — a calendar date or relative (e.g. “0 days” = through end of today). Empty = no upper bound. (Base field `endDate` is still accepted.)" }, "proxyConfiguration": { "title": "🌐 Apify Proxy (residential)", "type": "object", "description": "🏠 Apify Proxy (default): turn Use Apify Proxy on — traffic uses residential IPs only (UI group/type ignored; country still applies when set). Your own proxies: turn it off and add proxy URLs — the run tries yours first, then falls back to Apify 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 } } }, "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 } } } } } } } } } }