{ "openapi": "3.0.1", "info": { "title": "Competitor Intent Intelligence", "description": "Paste a competitor domain. Auto-discover high-value commercial pages, use public history when available, infer likely intent, predict next moves and return decision-ready actions.", "version": "0.0", "x-build-id": "6CKqkngcntxeWxvla" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/northpeak_data~ecommerce-change-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-northpeak_data-ecommerce-change-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/northpeak_data~ecommerce-change-intelligence/runs": { "post": { "operationId": "runs-sync-northpeak_data-ecommerce-change-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/northpeak_data~ecommerce-change-intelligence/run-sync": { "post": { "operationId": "run-sync-northpeak_data-ecommerce-change-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": { "urls": { "title": "Direct competitor pages (optional)", "type": "array", "description": "Optional direct product, category, collection, pricing, promotion, or landing-page URLs. You can use these together with competitor domains.", "default": [], "items": { "type": "string" } }, "monitorId": { "title": "Monitoring project name", "type": "string", "description": "Optional name used to keep each competitor/project history separate.", "default": "default" }, "compareMode": { "title": "What should I watch?", "enum": [ "commerce", "content", "all" ], "type": "string", "description": "Choose whether to focus on commercial signals, content changes, or both.", "default": "commerce" }, "outputMode": { "title": "What should I return?", "enum": [ "all", "changesOnly" ], "type": "string", "description": "Return every checked page or only baselines, detected changes, and errors.", "default": "all" }, "changeThreshold": { "title": "Minimum change score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only flag a page as changed when its weighted change score reaches this value.", "default": 1 }, "intentWindowHours": { "title": "Causal evidence window (hours)", "minimum": 24, "maximum": 720, "type": "integer", "description": "Time window used to connect commercial events into competing causal hypotheses.", "default": 168 }, "minimumEvidenceQuality": { "title": "Minimum evidence quality", "minimum": 0, "maximum": 100, "type": "integer", "description": "Below this quality score the Actor recommends watching rather than acting.", "default": 35 }, "maxHistoryEvents": { "title": "Maximum retained events per page", "minimum": 10, "maximum": 500, "type": "integer", "description": "Maximum commercial events retained for longitudinal reconstruction.", "default": 100 }, "maxPages": { "title": "Maximum pages per run", "minimum": 1, "maximum": 100, "type": "integer", "description": "Safety limit for pages processed in one run.", "default": 10 }, "decisionAlertWebhookUrl": { "title": "Decision alert webhook (optional)", "type": "string", "description": "Send high-confidence competitor decision briefs directly to a webhook or Slack-compatible incoming webhook. Leave blank to disable delivery.", "default": "" }, "minimumAlertConfidence": { "title": "Minimum confidence for alerts", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only deliver a decision alert when inferred intent confidence reaches this threshold and evidence quality also passes the configured minimum.", "default": 60 }, "instantFirstRun": { "title": "Instant first-run intelligence", "type": "boolean", "description": "On a new URL, try a free public historical snapshot before falling back to a normal baseline.", "default": true }, "historicalMinAgeDays": { "title": "Minimum historical snapshot age (days)", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Ignore archive captures newer than this so the first comparison has meaningful temporal separation.", "default": 7 }, "competitorDomains": { "title": "Competitor domains (auto-discover)", "type": "array", "description": "Paste competitor domains such as example.com. The Actor automatically discovers high-value commercial pages such as pricing, products/collections, promotions and updates.", "default": [], "items": { "type": "string" } }, "autoDiscoverMaxPages": { "title": "Auto-discovered pages per domain", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum high-value commercial pages automatically selected from each competitor domain.", "default": 3 } } }, "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 } } } } } } } } } }