{ "openapi": "3.0.1", "info": { "title": "Competitor Price & Stock Intelligence", "description": "Track competitor price changes, stockouts and restocks. Detect commercial moves, score their impact, uncover opportunities and get actionable decision briefs. Turn ecommerce monitoring into smarter pricing decisions.", "version": "0.0", "x-build-id": "AHIVxZsMNaozjYGTl" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/northpeak_data~ecommerce-change-intelligence-1/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-northpeak_data-ecommerce-change-intelligence-1", "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/northpeak_data~ecommerce-change-intelligence-1/runs": { "post": { "operationId": "runs-sync-northpeak_data-ecommerce-change-intelligence-1", "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/northpeak_data~ecommerce-change-intelligence-1/run-sync": { "post": { "operationId": "run-sync-northpeak_data-ecommerce-change-intelligence-1", "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", "required": [ "urls" ], "properties": { "urls": { "title": "Competitor pages to monitor", "type": "array", "description": "Public ecommerce product or category URLs. Start with one real product page that exposes price or availability; the first run creates a baseline, not a price-change alert.", "default": [], "items": { "type": "string" } }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Use the same Monitor ID and URLs on future runs to compare against your baseline. Changing the ID starts a new monitoring history.", "default": "default" }, "compareMode": { "title": "Comparison mode", "enum": [ "commerce", "content", "all" ], "type": "string", "description": "Focus on commercial signals, content changes, or both.", "default": "commerce" }, "outputMode": { "title": "Output mode", "enum": [ "all", "changesOnly" ], "type": "string", "description": "Return all checks or only changed pages, baselines, and errors. Output records may be billable according to Store pricing.", "default": "all" }, "changeThreshold": { "title": "Minimum change score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Minimum weighted score before a change is flagged.", "default": 1 }, "maxPages": { "title": "Maximum pages per run", "minimum": 1, "maximum": 100, "type": "integer", "description": "Safety limit for pages processed per run.", "default": 10 }, "aggregateMoves": { "title": "Aggregate coordinated competitor moves", "type": "boolean", "description": "Group multiple changed pages from the same competitor into one commercial-move intelligence record.", "default": true }, "validation": { "title": "Validation override (testing only)", "type": "object", "description": "Optional controlled values used only to validate the intelligence pipeline end-to-end. Leave disabled for normal monitoring.", "properties": { "enabled": { "title": "Enable validation override", "description": "Enable controlled test overrides for this run only.", "type": "boolean", "default": false }, "prices": { "title": "Validation prices", "description": "Override extracted prices with controlled values for end-to-end validation.", "type": "array", "items": { "type": "string" } }, "inStock": { "title": "Validation in-stock state", "description": "Override the detected stock state for end-to-end validation.", "type": "boolean" } } } } }, "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 } } } } } } } } } }