{ "openapi": "3.0.1", "info": { "title": "Meta Ads Competitor Intelligence Report", "description": "Turn Facebook / Meta Ads Library scraper datasets into weekly competitor intelligence reports. Generate a client-ready Markdown report, JSON summary, and CSV evidence export with top advertisers, offer-angle signals, CTA domains, and traceable ad IDs.", "version": "0.2", "x-build-id": "vDgleEBZLXWaec8Jz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jy-labs~weekly-competitor-ad-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jy-labs-weekly-competitor-ad-intelligence", "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/jy-labs~weekly-competitor-ad-intelligence/runs": { "post": { "operationId": "runs-sync-jy-labs-weekly-competitor-ad-intelligence", "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/jy-labs~weekly-competitor-ad-intelligence/run-sync": { "post": { "operationId": "run-sync-jy-labs-weekly-competitor-ad-intelligence", "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": { "reportName": { "title": "Report name", "type": "string", "description": "Human-readable report title shown in REPORT and OUTPUT.", "default": "Weekly Competitor Ad Intelligence" }, "datasetId": { "title": "Current Meta dataset ID", "type": "string", "description": "Dataset ID from a Facebook / Meta Ads Library scraper run, for example Apify's Facebook Ads Library Scraper or another compatible Meta ad export. Use this, runId, or inline items." }, "runId": { "title": "Current Meta run ID", "type": "string", "description": "Run ID from a Meta Ad Library scraper run. The Actor loads the run's default dataset." }, "items": { "title": "Inline current Meta ad rows", "type": "array", "description": "Inline rows exported from a Facebook / Meta Ads Library scraper. Useful for samples, API calls, or testing the report format without another dataset.", "items": { "type": "object", "additionalProperties": true } }, "baselineDatasetId": { "title": "Baseline dataset ID", "type": "string", "description": "Optional previous Meta dataset ID for week-over-week change comparison. If omitted, the report is an initial snapshot." }, "baselineRunId": { "title": "Baseline run ID", "type": "string", "description": "Optional previous Meta scraper run ID for change comparison." }, "baselineItems": { "title": "Inline baseline ad rows", "type": "array", "description": "Optional prior rows for change comparison. If omitted, the report is an initial snapshot.", "items": { "type": "object", "additionalProperties": true } }, "search": { "title": "Search criteria metadata", "type": "object", "description": "Keywords, country, activeStatus, Page IDs, and period shown in the report. This metadata does not run the Meta scraper by itself.", "default": { "keywords": [ "Nike", "Puma", "New Balance" ], "country": "US", "activeStatus": "active" }, "additionalProperties": true }, "maxItems": { "title": "Max source rows", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum rows to load from dataset/run sources. Larger values create bigger CSV evidence exports.", "default": 500 }, "includeTikTokExperimental": { "title": "Mark TikTok as experimental/fallback", "type": "boolean", "description": "Scope control only. TikTok is not a core source and must not be sold as full platform analytics in this MVP.", "default": 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 } } } } } } } } } }