{ "openapi": "3.0.1", "info": { "title": "Facebook Ads Library Scraper: Creative & Ad Text Details", "description": "Facebook Ads Library Scraper extracts ads from the Facebook Ads Library, capturing ad creatives, texts, impressions, spend ranges, regions, advertiser info, start/end dates, and transparency data. Ideal for competitor research, ad monitoring, political ad tracking, and automated marketing insights.", "version": "0.1", "x-build-id": "5HHslGpA6SXlKq5VP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/simpleapi~facebook-ads-library-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-simpleapi-facebook-ads-library-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/simpleapi~facebook-ads-library-scraper/runs": { "post": { "operationId": "runs-sync-simpleapi-facebook-ads-library-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/simpleapi~facebook-ads-library-scraper/run-sync": { "post": { "operationId": "run-sync-simpleapi-facebook-ads-library-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": { "watchlist": { "title": "๐ŸŽฏ Competitor pages or Ad Library links", "type": "array", "description": "๐Ÿ“‹ One entry per line. Plain page URLs, Ad Library links, or objects with a `url` field (optional `label`, `limit`, `period` per item). Example: two competitor pages โ†’ both are collected, deduped by creative, and rolled up per advertiser.", "items": { "type": "string" } }, "extraCompetitorPages": { "title": "โž• Merge in more competitor targets", "type": "array", "description": "๐Ÿ“Ž Additional pages or Ad Library links appended to the watchlist above and deduplicated. Handy when you keep a fixed watchlist and drop in one-off competitors per run. Accepts plain URLs or `{url,label,limit,period}` objects.", "items": { "type": "string" } }, "maxAdsPerCompetitor": { "title": "๐Ÿ”ข Ad budget for this run", "minimum": 1, "maximum": 50000, "type": "integer", "description": "๐Ÿ“ˆ Upper bound on ads returned **across every watchlist target** this run. Lower = faster snapshots; higher = broader competitor coverage. Example: maxAdsPerCompetitor=25 across 2 pages โ†’ at most 25 ad rows total. **Leave empty** for the default of 10." }, "sortBy": { "title": "โ†•๏ธ Sort ads by", "enum": [ "most_recent", "oldest", "longest_running", "shortest_running", "advertiser" ], "type": "string", "description": "๐Ÿ† How to order the returned ads. `Longest running` surfaces proven winners first. Default is most recent.", "default": "most_recent" }, "formatFilter": { "title": "๐ŸŽจ Creative format", "enum": [ "all", "video", "image", "carousel" ], "type": "string", "description": "๐Ÿ–ผ๏ธ Keep only ads of a given creative type. `Carousel` = multi-card ads. Default keeps every format.", "default": "all" }, "platformFilter": { "title": "๐Ÿ“บ Publisher platform", "enum": [ "all", "facebook", "instagram", "messenger", "audience_network", "whatsapp" ], "type": "string", "description": "๐Ÿ“ฑ Keep only ads shown on a given Meta surface. Default keeps ads from every platform.", "default": "all" }, "activeSince": { "title": "๐Ÿ“… Only ads started on/after", "pattern": "^$|^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$", "type": "string", "description": "โณ Keep only ads whose delivery started on or after this point. Pick a calendar date (e.g. 2025-01-01) or a relative span (e.g. 30 days, 3 months). **Leave empty** for no date filter.", "default": "" }, "adStatus": { "title": "โšก Ad activity to track", "enum": [ "all", "active", "inactive" ], "type": "string", "description": "๐ŸŽ›๏ธ Which delivery state to monitor for page targets (or when your Ad Library link leaves it unspecified). Track only live campaigns, only retired ones, or both. Defaults to both." }, "dedupeByCollation": { "title": "๐Ÿงน Dedupe near-identical creatives", "type": "boolean", "description": "๐Ÿช„ Collapse creative variations that share the same `collationId` to one row each โ€” a cleaner unique-creatives view of a competitor. Off by default (returns every ad, matching the base).", "default": false }, "lookbackWindow": { "title": "๐Ÿ•ฐ๏ธ Library lookback window", "pattern": "^$|^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$", "type": "string", "description": "โŒ› Optional time window passed to the Ad Library when your URL does not specify one. **Leave empty** to follow the library default. Calendar date or relative span (e.g. 7 days). This is the library's own date scoping โ€” separate from the `Only ads started on/after` tracking filter." }, "market": { "title": "๐ŸŒ Default advertiser market", "enum": [ "ALL", "AR", "AU", "AT", "BD", "BE", "BR", "CA", "CL", "CN", "CO", "CR", "CZ", "DK", "EC", "EG", "FI", "FR", "DE", "GR", "GT", "HK", "HU", "IN", "ID", "IE", "IL", "IT", "JP", "KE", "MY", "MX", "NL", "NZ", "NG", "NO", "PK", "PA", "PE", "PH", "PL", "PT", "PR", "RO", "RU", "SA", "SG", "ZA", "KR", "ES", "SE", "CH", "TW", "TH", "TR", "AE", "GB", "US", "UY", "VE", "VN", "UA" ], "type": "string", "description": "๐Ÿ“ Country/region used for Facebook page targets. Ad Library links usually carry their own country in the URL, which takes precedence. Defaults to worldwide." }, "listingOnlyMode": { "title": "๐Ÿชถ Lightweight listing-only mode", "type": "boolean", "description": "๐Ÿ” Leave OFF (default) to deep-fetch each ad for richer creative/transparency metadata. Turn ON for a faster, lighter listing-only monitoring export that skips the per-ad detail lookup." }, "includePageProfile": { "title": "โ„น๏ธ Attach page โ€œaboutโ€ profile", "type": "boolean", "description": "๐Ÿ“„ For Facebook page targets, attach lightweight public title/description text about the advertiser when available." }, "countsOnlyAudit": { "title": "๐Ÿ”ข Counts-only competitor audit", "type": "boolean", "description": "๐Ÿ“‰ Output one summary row per target with a total ad count instead of one row per ad โ€” a quick way to size each competitor's active ad volume before a deep run." }, "proxyConfiguration": { "title": "๐Ÿ›ก๏ธ Proxy (optional)", "type": "object", "description": "๐Ÿ  Leave off for a standard run. If you enable Apify Proxy here, only residential proxy traffic is used for the whole run. Requires proxy access on your Apify plan." } } }, "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 } } } } } } } } } }