{ "openapi": "3.0.1", "info": { "title": "Paid Media Destination Continuity Monitor: Affiliate Link QA", "description": "Detect broken affiliate redirects and unexpected tracking changes. Check ad landings, tracking parameters and optional Shopify buyability. Two-strike failures. Does not claim commission attribution. $0.004/destination, $0.005/Shopify, $0.0015/HTTP link, $0.005/browser link. Blocked and unknown free.", "version": "0.1", "x-build-id": "F8qS1Z0rYutTw3bUe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/latentlark~paid-media-destination-continuity-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-latentlark-paid-media-destination-continuity-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/latentlark~paid-media-destination-continuity-monitor/runs": { "post": { "operationId": "runs-sync-latentlark-paid-media-destination-continuity-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/latentlark~paid-media-destination-continuity-monitor/run-sync": { "post": { "operationId": "run-sync-latentlark-paid-media-destination-continuity-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", "properties": { "ads": { "title": "Ads and destinations", "minItems": 1, "maxItems": 25, "type": "array", "description": "Each item is one ad destination URL. Multiple ads may share a URL; results fan out every linked adId. The prefill checks example.com plus Shopify's public Dawn demo product (Thelma sandal / Black 35). You may also pass links instead of, or in addition to, ads.", "items": { "type": "object", "required": [ "destinationUrl" ], "properties": { "adId": { "title": "Ad ID", "type": "string", "description": "Your ad or campaign identifier. Not fetched remotely.", "editor": "textfield", "maxLength": 120, "example": "ad-123" }, "platform": { "title": "Platform", "type": "string", "description": "Optional platform label: meta, tiktok, google, linkedin, or other. Not fetched remotely.", "editor": "textfield", "maxLength": 40 }, "destinationUrl": { "title": "Destination URL", "type": "string", "description": "HTTPS landing URL to check (read-only GET).", "editor": "textfield", "example": "https://example.com/" }, "expectedDomain": { "title": "Expected domain", "type": "string", "description": "If set, a final redirect host outside this domain is a failure.", "editor": "textfield", "example": "example.com" }, "requiredText": { "title": "Required text", "type": "array", "description": "All of these substrings must appear in the final HTML body.", "editor": "stringList", "items": { "type": "string", "maxLength": 200 } }, "forbiddenText": { "title": "Forbidden text", "type": "array", "description": "If any substring appears, the destination fails assertions (e.g. Sold out).", "editor": "stringList", "items": { "type": "string", "maxLength": 200 } }, "shopifyProductUrl": { "title": "Shopify product URL", "type": "string", "description": "Optional. When set with variantId, also checks /products/{handle}.js.", "editor": "textfield", "example": "https://theme-dawn-demo.myshopify.com/products/thelma-sandal" }, "variantId": { "title": "Shopify variant ID", "type": "string", "description": "Required with shopifyProductUrl.", "editor": "textfield", "pattern": "^[1-9][0-9]{0,24}$", "example": "39576998346841" }, "label": { "title": "Label", "type": "string", "editor": "textfield", "maxLength": 120, "description": "Optional label for this ad row. Not sent to destinations." }, "requiredParams": { "title": "Required tracking parameters", "type": "array", "description": "Parameters to inspect. A missing parameter is not an automatic failure unless severity is error.", "editor": "json", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "title": "Parameter name", "type": "string", "description": "Query parameter to inspect, for example awinaffid or tag.", "editor": "textfield", "maxLength": 80 }, "expectedValue": { "title": "Expected value", "type": "string", "description": "Optional. Compared only against this parameter on the start URL, not against a network-issued click ID after a rename.", "editor": "textfield" }, "aliases": { "title": "Aliases", "type": "array", "description": "Other names that count as the same parameter (for example awc for awinaffid).", "editor": "stringList", "items": { "type": "string", "maxLength": 80 } }, "severity": { "title": "Severity", "type": "string", "description": "info, warning, or error. Default is warning, so a missing or consumed parameter is not an automatic failure.", "enum": [ "info", "warning", "error" ], "default": "warning" } } } } } } }, "enableShopifyChecks": { "title": "Enable Shopify checks", "type": "boolean", "description": "When false, shopifyProductUrl / variantId fields are ignored and no Shopify request is sent.", "default": true }, "previousSnapshot": { "title": "Previous snapshot", "type": "object", "description": "Optional OUTPUT.snapshot from an earlier run. Used for two-strike confirmation when you are not on a saved Apify task." }, "stateScope": { "title": "State scope", "pattern": "^[A-Za-z0-9_-]{1,64}$", "type": "string", "description": "Optional persistence name for local or non-task runs. An Apify task ID always wins so two tasks cannot share state by accident." }, "maxAds": { "title": "Ad cap", "minimum": 1, "maximum": 25, "type": "integer", "description": "Optional ad count cap of 25 or less.", "default": 25 }, "maxUniqueUrls": { "title": "Unique URL cap", "minimum": 1, "maximum": 15, "type": "integer", "description": "Optional unique destination URL cap of 15 or less.", "default": 15 }, "maxRequests": { "title": "Request cap", "minimum": 1, "maximum": 80, "type": "integer", "description": "Optional HTTP request budget of 80 or less (robots, redirects, retries included).", "default": 80 }, "maxShopifyProducts": { "title": "Shopify product cap", "minimum": 1, "maximum": 3, "type": "integer", "description": "Optional Shopify product cap of 3 or less.", "default": 3 }, "timeoutSeconds": { "title": "Timeout seconds", "minimum": 5, "maximum": 180, "type": "integer", "description": "Wall-clock budget for this run. Cannot exceed 180. The Store example uses 90 and should finish in well under 2 minutes.", "default": 90 }, "confirmFailures": { "title": "Confirm failures (strikes)", "minimum": 1, "maximum": 2, "type": "integer", "description": "Consecutive failure observations required before confirmedFailure / confirmedShopifyFailure. Default 2. Cannot exceed 2.", "default": 2 }, "links": { "title": "Affiliate or tracking links", "minItems": 1, "maxItems": 25, "type": "array", "description": "Optional alternative to ads. Each item needs a url or destinationUrl. Same fields as ads, plus optional per-link requiredParams. Used with ads, or on its own.", "items": { "type": "object", "properties": { "url": { "title": "Link URL", "type": "string", "description": "HTTPS tracking or destination URL (read-only GET). Same as destinationUrl.", "editor": "textfield", "example": "https://www.awin1.com/cread.php?awinmid=1234&awinaffid=9999&ued=https%3A%2F%2Fexample.com%2F" }, "destinationUrl": { "title": "Destination URL", "type": "string", "description": "Alternative field name for the same HTTPS URL.", "editor": "textfield" }, "expectedDomain": { "title": "Expected final domain", "type": "string", "description": "If set, a final host outside this domain is a failure.", "editor": "textfield", "example": "example.com" }, "requiredParams": { "title": "Required tracking parameters", "type": "array", "description": "Parameters to inspect. A missing parameter is not an automatic failure unless severity is error.", "editor": "json", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "title": "Parameter name", "type": "string", "description": "Query parameter to inspect, for example awinaffid or tag.", "editor": "textfield", "maxLength": 80 }, "expectedValue": { "title": "Expected value", "type": "string", "description": "Optional. Compared only against this parameter on the start URL, not against a network-issued click ID after a rename.", "editor": "textfield" }, "aliases": { "title": "Aliases", "type": "array", "description": "Other names that count as the same parameter (for example awc for awinaffid).", "editor": "stringList", "items": { "type": "string", "maxLength": 80 } }, "severity": { "title": "Severity", "type": "string", "description": "info, warning, or error. Default is warning, so a missing or consumed parameter is not an automatic failure.", "enum": [ "info", "warning", "error" ], "default": "warning" } } } }, "adId": { "title": "Ad or link ID", "type": "string", "editor": "textfield", "maxLength": 120, "description": "Your ad or campaign identifier. Not fetched remotely." }, "label": { "title": "Label", "type": "string", "editor": "textfield", "maxLength": 120, "description": "Optional label for this link. Not sent to destinations." }, "requiredText": { "title": "Required text", "type": "array", "editor": "stringList", "items": { "type": "string", "maxLength": 200 }, "description": "All of these substrings must appear in the final HTML body." }, "forbiddenText": { "title": "Forbidden text", "type": "array", "editor": "stringList", "items": { "type": "string", "maxLength": 200 }, "description": "If any substring appears, the destination fails assertions." } } } }, "requiredParams": { "title": "Global required tracking parameters", "type": "array", "description": "Inspect these query parameters across every link. Default severity is warning, so a missing or consumed parameter is not an automatic failure. Networks may drop or rename parameters; add aliases or per-hop rules for that.", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "title": "Parameter name", "type": "string", "description": "Query parameter to inspect, for example awinaffid or tag.", "editor": "textfield", "maxLength": 80 }, "expectedValue": { "title": "Expected value", "type": "string", "description": "Optional. Compared only against this parameter on the start URL, not against a network-issued click ID after a rename.", "editor": "textfield" }, "aliases": { "title": "Aliases", "type": "array", "description": "Other names that count as the same parameter (for example awc for awinaffid).", "editor": "stringList", "items": { "type": "string", "maxLength": 80 } }, "severity": { "title": "Severity", "type": "string", "description": "info, warning, or error. Default is warning, so a missing or consumed parameter is not an automatic failure.", "enum": [ "info", "warning", "error" ], "default": "warning" } } } }, "paramRules": { "title": "Parameter validation rules", "type": "object", "description": "Configurable validation. aliases maps a required name to other names (for example clickref to awc). perHop is a list of {hostSuffix, mayDrop, mayRename} rules. useDefaultNetworkRules (default true) applies built-in consume/rename rules for Awin, Impact, CJ and Amazon-style hosts. defaultSeverity is info, warning, or error (default warning).", "properties": { "aliases": { "title": "Aliases", "type": "object", "description": "Map of parameter name to a list of alias names." }, "perHop": { "title": "Per-hop rules", "type": "array", "editor": "json", "items": { "type": "object", "required": [ "hostSuffix" ], "properties": { "hostSuffix": { "title": "Host suffix", "type": "string", "editor": "textfield", "description": "Hostname suffix to match, for example awin1.com." }, "mayDrop": { "title": "May drop", "type": "array", "editor": "stringList", "items": { "type": "string" }, "description": "Parameter names this host may legitimately drop." }, "mayRename": { "title": "May rename", "type": "object", "editor": "json", "description": "Map of original parameter names to the names this host may emit instead." } } }, "description": "Host-specific consume and rename rules applied when a parameter disappears after that host." }, "useDefaultNetworkRules": { "title": "Use built-in network rules", "type": "boolean", "default": true, "description": "When true (default), apply built-in consume and rename rules for Awin, Impact, CJ and Amazon-style hosts." }, "defaultSeverity": { "title": "Default severity", "type": "string", "enum": [ "info", "warning", "error" ], "default": "warning", "description": "Severity used when a required parameter does not set its own. Default is warning." } } }, "renderMode": { "title": "Render mode", "enum": [ "http", "browser" ], "type": "string", "description": "http is the default fast mode (Location headers, plus meta-refresh and simple JS redirects when followClientRedirects is on). browser uses a headless Chromium render for JS-driven or meta-refresh chains. Use a higher memory run (1024 MB) for browser mode. The Store example stays on http.", "default": "http" }, "followClientRedirects": { "title": "Follow meta-refresh and simple JS redirects in HTTP mode", "type": "boolean", "description": "When true, HTTP mode also follows meta-refresh and simple location.href / location.replace assignments found in HTML. Defaults to true when affiliate fields are used, and false for classic ads-only inputs so existing behaviour stays the same." }, "respectRobots": { "title": "Respect robots.txt", "type": "boolean", "description": "When true (default), the Actor fetches robots.txt and skips disallowed paths. Set false to inspect specific tracking URLs you own when a network's robots.txt would otherwise block the check.", "default": true } } }, "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 } } } } } } } } } }