{ "openapi": "3.0.1", "info": { "title": "Meta Ad Monitor: Facebook Ad Library Scraper", "description": "Facebook Ads monitor and Meta Ad Library scraper: track competitor Facebook and Instagram ads between scheduled runs. See new launches, killed creatives and proven winners, with ad copy, CTA, links and media by advertiser. A Facebook Ad Library scraper with change detection and reporting.", "version": "2.0", "x-build-id": "YPtremZ5ezXNvDqWU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/deepmine~meta-ad-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-deepmine-meta-ad-monitor", "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/deepmine~meta-ad-monitor/runs": { "post": { "operationId": "runs-sync-deepmine-meta-ad-monitor", "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/deepmine~meta-ad-monitor/run-sync": { "post": { "operationId": "run-sync-deepmine-meta-ad-monitor", "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", "required": [ "advertiserNames" ], "properties": { "advertiserNames": { "title": "Advertisers to Monitor", "type": "array", "description": "Facebook page names or advertiser names to monitor, one per line. A Facebook page link (facebook.com/nike) or page id works too. Each advertiser is tracked independently: the tool shows which ads are new, how many got killed, and how many have been running long enough to be proven winners.", "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "Country to search ads for. Uses ISO 2-letter country code. US covers the most advertisers.", "default": "US" }, "maxAdsPerAdvertiser": { "title": "Max Ads Per Advertiser", "minimum": 10, "maximum": 1000, "type": "integer", "description": "Maximum number of ads to return per advertiser in a run (a hard cap). You pay per ad, so this caps the cost of each advertiser. With Track Changes on, it caps the new ads per run (more new ads come with the next run).", "default": 200 }, "trackChanges": { "title": "Track Changes Between Runs", "type": "boolean", "description": "The core monitoring feature. Each run remembers what it returned. The next run returns only the ads launched since then, and the summary counts new ads, killed ads and proven winners. You pay only for the new ads.\n\nRun on a schedule (daily or weekly) to continuously track competitor ad strategy. The first run returns the newest ads and sets the baseline. Turn it off to get every active ad on each run.", "default": true }, "includeSummaryRows": { "title": "Add summary rows (free)", "type": "boolean", "description": "Every run saves one summary per advertiser (status, active ads, new and killed ads, proven winners, longest-running ad) in the SUMMARY record of the run's key-value store, free. Turn this on to also get those summaries as rows, as older versions did. They go to a separate dataset of the run, so they stay free: its link is summaryRowsUrl in the run details (OUTPUT record). The ads stay in the run's dataset.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy for reading deep pages of an advertiser's ads. Residential is the default and recommended: Meta refuses most datacenter IPs past the first page of results. Advertiser lookups, the newest ads and the summary's counts are read on Apify's datacenter proxy at no extra cost.", "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 } } } } } } } } } }