{ "openapi": "3.0.1", "info": { "title": "Competitor Page Change Monitor", "description": "Type a competitor's website and get alerts on what changed on their pricing, plans and services pages, with source evidence. Reads JavaScript-built pages too.", "version": "0.3", "x-build-id": "wsYMlMOOtNdNbNQl9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexuslead~nexus-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexuslead-nexus-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/nexuslead~nexus-intelligence/runs": { "post": { "operationId": "runs-sync-nexuslead-nexus-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/nexuslead~nexus-intelligence/run-sync": { "post": { "operationId": "run-sync-nexuslead-nexus-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": { "competitors": { "title": "Competitor websites (easiest)", "maxItems": 20, "type": "array", "description": "Just type each competitor's website, like acme.com. The Actor finds their pricing, plans and services pages for you (from the homepage links and sitemap) and watches those. Up to 20 websites. Combine with the page list below if you like.", "items": { "type": "string" } }, "pagesPerCompetitor": { "title": "Pages to watch per competitor", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many of the best-matching pages to watch on each competitor website.", "default": 3 }, "urls": { "title": "Exact page URLs (optional)", "maxItems": 50, "type": "array", "description": "Optional. Exact public HTTPS pages to watch. Use this when you already know the page, or for pages the finder misses. These are watched first. Duplicates are captured once.", "items": { "type": "string" } }, "maxPages": { "title": "Maximum pages to inspect", "minimum": 1, "maximum": 50, "type": "integer", "description": "Hard cap on pages per run in total (exact pages plus found pages), after deduplication. Successful captures count as results even if the text is unchanged.", "default": 10 }, "renderMode": { "title": "How to read pages", "enum": [ "auto", "html", "browser" ], "type": "string", "description": "Auto reads the page's HTML first and switches to a real browser only when a page needs JavaScript or looks blocked. HTML only is fastest and cheapest. Browser always uses a real browser (slower, billed as a browser result).", "default": "auto" }, "includeText": { "title": "Include captured source text", "type": "boolean", "description": "Include the captured page text in each output row (at most 24,000 characters). Saved baselines always keep the text in your own storage regardless of this setting.", "default": true }, "previousResults": { "title": "Earlier successful results (optional)", "maxItems": 50, "type": "array", "description": "Optional. Paste captured rows from an earlier run to compare against them instead of the saved baselines. Rows must be successful captures that include text, requestedUrl, url and capturedAt.", "default": [] }, "rememberBaselines": { "title": "Remember pages between runs", "type": "boolean", "description": "Saves the latest successful capture of each URL in a private storage in your own Apify account, so the next run shows what changed with no copy-pasting. Turn off for a stateless run.", "default": true }, "baselineStoreName": { "title": "Baseline storage name", "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$", "minLength": 3, "maxLength": 63, "type": "string", "description": "Name of the key-value store in your account that holds saved pages. Use a different name to keep separate watchlists. 3-63 lowercase letters, numbers and hyphens.", "default": "nexus-intelligence-baselines" } } }, "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 } } } } } } } } } }