{ "openapi": "3.0.1", "info": { "title": "Creator Campaign Link Monitor", "description": "Check sponsorship and bio links for broken destinations, unexpected redirects and missing required tracking parameters. Compare campaign watchlists across runs. Export JSON, CSV and a readable agency report.", "version": "0.0", "x-build-id": "gveI3z7eKCoF7k4Sn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/symmetrical_omelet_yit~creator-campaign-link-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-symmetrical_omelet_yit-creator-campaign-link-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/symmetrical_omelet_yit~creator-campaign-link-monitor/runs": { "post": { "operationId": "runs-sync-symmetrical_omelet_yit-creator-campaign-link-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/symmetrical_omelet_yit~creator-campaign-link-monitor/run-sync": { "post": { "operationId": "run-sync-symmetrical_omelet_yit-creator-campaign-link-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": { "demoMode": { "title": "๐Ÿงช Try the sample campaign report", "type": "boolean", "description": "See fixed examples of healthy, broken, redirected and blocked links. No network requests or history writes. Turn this off to check your campaign; keep other settings at their defaults for the sample.", "default": false }, "campaignLinks": { "title": "๐Ÿ”— Campaign destination links", "maxItems": 100, "type": "array", "description": "Paste the actual destination or shortened links from your bio, sponsored description or campaign sheet. Supply public HTTP/HTTPS URLs on standard ports. Social profile/post links are not scraped for destinations. Duplicate URLs are checked once.", "items": { "type": "string" }, "default": [] }, "campaignName": { "title": "๐Ÿท๏ธ Campaign name", "maxLength": 80, "type": "string", "description": "Name shown on the report. Keep Campaign selected for the sample.", "default": "Campaign" }, "expectedDomain": { "title": "๐ŸŒ Expected destination domain", "maxLength": 253, "type": "string", "description": "Optional merchant hostname, for example your-brand.com. That exact host and its subdomains are accepted. Leave empty to accept any public destination.", "default": "" }, "requiredParameters": { "title": "๐ŸŽฏ Required tracking parameters", "maxItems": 10, "uniqueItems": true, "type": "array", "description": "Case-sensitive query parameter names that must have nonempty values at a reachable final URL. Use your affiliate parameter names if appropriate, or clear all for health-only checks. URL checks do not prove analytics attribution or sales.", "items": { "type": "string" }, "default": [ "utm_source", "utm_medium", "utm_campaign" ] }, "watchlistName": { "title": "๐Ÿ” Watchlist name", "maxLength": 80, "type": "string", "description": "Optional, for example autumn-creators. Baselines stay in an Actor-created named key-value store in your Apify account. First checks establish a baseline; uncertain observations do not replace confirmed ones.", "default": "" }, "maxRedirects": { "title": "โ†ช๏ธ Maximum redirects per link", "minimum": 0, "maximum": 10, "type": "integer", "description": "Stop after this many redirects. Maximum 10.", "default": 8 }, "timeoutSeconds": { "title": "โฑ๏ธ Time limit per link (seconds)", "minimum": 5, "maximum": 30, "type": "integer", "description": "Total time budget including DNS, connections, TLS and redirect headers. Maximum 30 seconds.", "default": 20 } } }, "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 } } } } } } } } } }