{ "openapi": "3.0.1", "info": { "title": "Competitor Ad Strategy Brief — Offers, Messaging & Changes", "description": "Turn supplied Meta ad JSON or selected Apify datasets into a brand research report: observed offers, messaging, CTAs, destination URLs, sample changes and test hypotheses. Printable HTML + JSON. Free fictional demo. No AI key.", "version": "0.1", "x-build-id": "ewfDcIxmuE6yiiqay" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/elfajad~competitor-ad-strategy-brief/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-elfajad-competitor-ad-strategy-brief", "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/elfajad~competitor-ad-strategy-brief/runs": { "post": { "operationId": "runs-sync-elfajad-competitor-ad-strategy-brief", "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/elfajad~competitor-ad-strategy-brief/run-sync": { "post": { "operationId": "run-sync-elfajad-competitor-ad-strategy-brief", "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": { "mode": { "title": "Input mode", "enum": [ "demo", "inline", "dataset" ], "type": "string", "description": "Demo always uses fixed fictional data and does not trigger the $15 report event. Select inline or dataset for your own data.", "default": "demo" }, "brandName": { "title": "Brand / advertiser name", "maxLength": 120, "type": "string", "description": "Required for inline/dataset mode. Used as the report label. Rows must describe only one advertiser." }, "currentAds": { "title": "Current ad JSON", "maxItems": 100, "type": "array", "description": "Inline mode: paste an array exported from an ad scraper, or normalized objects with id, advertiserName, body, cta, landingPageUrl, format, isActive and startDate. Maximum 100 rows.", "items": { "type": "object" } }, "previousAds": { "title": "Previous ad JSON (optional)", "maxItems": 100, "type": "array", "description": "Inline mode: same advertiser's previous sample. Stable IDs allow exact record comparisons. Missing ads are labeled not seen, not stopped.", "items": { "type": "object" } }, "currentDatasetId": { "title": "Current source dataset", "type": "string", "description": "Dataset mode: explicitly select one dataset containing only this advertiser's ads. Reads at most 101 rows, analyzes the first 100. Source is read-only." }, "previousDatasetId": { "title": "Previous source dataset (optional)", "type": "string", "description": "Dataset mode: select an earlier ad dataset for the same advertiser. No source writes." }, "observedAt": { "title": "Current observation date (optional)", "type": "string", "description": "ISO date/time of collection, e.g. 2026-09-28T12:00:00Z. If omitted, analysis time is used and source freshness remains unknown." }, "previousObservedAt": { "title": "Previous observation date (optional)", "type": "string", "description": "ISO date/time of the earlier sample. Must precede current observedAt if both are provided." }, "reportLabel": { "title": "Report heading (optional)", "maxLength": 120, "type": "string", "description": "Optional heading on the printable report." } } }, "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 } } } } } } } } } }