{ "openapi": "3.0.1", "info": { "title": "Facebook Ads Library E-commerce Ad Intelligence", "description": "Pulls live ad creatives, copy, CTAs and run dates from Meta's public Ad Library for a keyword or advertiser Page, shaped as a per-ad competitor ad-spy feed for e-commerce and DTC brands.", "version": "1.0", "x-build-id": "Oe1U7mQDgq4YdcNEm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mibedk~facebook-ads-library-ecommerce-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mibedk-facebook-ads-library-ecommerce-tracker", "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/mibedk~facebook-ads-library-ecommerce-tracker/runs": { "post": { "operationId": "runs-sync-mibedk-facebook-ads-library-ecommerce-tracker", "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/mibedk~facebook-ads-library-ecommerce-tracker/run-sync": { "post": { "operationId": "run-sync-mibedk-facebook-ads-library-ecommerce-tracker", "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": { "searchTerms": { "title": "Search keywords", "type": "array", "description": "Brand names or keywords to search for, exactly as you'd type them into the Ad Library search box (e.g. an advertiser or product name). Ignored for any term also covered by 'Advertiser Page IDs' below. At least one of searchTerms or pageIds must be set.", "default": [ "Nike" ], "items": { "type": "string" } }, "pageIds": { "title": "Advertiser Page IDs", "type": "array", "description": "Numeric Facebook Page IDs to fetch all ads for (found via the 'View all Page ads' link or the Ad Library's page-info panel). Use this instead of, or alongside, searchTerms when you want every ad from specific advertisers rather than a keyword match.", "default": [], "items": { "type": "string" } }, "countryCode": { "title": "Country", "type": "string", "description": "Two-letter country code the Ad Library should search in (this is the country the ads targeted, not your own location).", "default": "US" }, "activeStatus": { "title": "Ad status", "enum": [ "active", "inactive", "all" ], "type": "string", "description": "Which ads to include. 'active' only returns ads currently running, which is what most competitor-tracking use cases want.", "default": "active" }, "maxAdsPerSearch": { "title": "Max ads per search term / Page", "minimum": 1, "maximum": 500, "type": "integer", "description": "Stop collecting once this many ads have been found for a given search term or Page ID. Keeps runs fast and predictable; raise it for deeper competitor audits.", "default": 20 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Off by default so the actor is free to try. Meta rate-limits and occasionally blocks requests from data-center IPs; if runs start failing, turn this on and pick the Residential proxy group.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }