{ "openapi": "3.0.1", "info": { "title": "Competitor Price Monitor - Product Matching & Stock Alerts", "description": "Monitor public retail offers with variant-aware product matching, price changes and stock evidence.", "version": "0.1", "x-build-id": "676D4l9tfn0SZJwWu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ntriqpro~retail-price-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ntriqpro-retail-price-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/ntriqpro~retail-price-monitor/runs": { "post": { "operationId": "runs-sync-ntriqpro-retail-price-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/ntriqpro~retail-price-monitor/run-sync": { "post": { "operationId": "run-sync-ntriqpro-retail-price-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": { "stores": { "title": "Shopify store roots", "maxItems": 20, "type": "array", "description": "Up to 20 public HTTPS Shopify roots. Do not combine a store with product URLs on the same host.", "items": { "type": "string" }, "default": [] }, "productUrls": { "title": "Product URLs", "maxItems": 100, "type": "array", "description": "Up to 100 public HTTPS product pages. Tracking parameters and fragments are removed.", "items": { "type": "string" }, "default": [] }, "referenceProducts": { "title": "Reference products", "maxItems": 1000, "type": "array", "description": "Up to 1,000 products identified by GTIN or brand plus MPN/model. Enter IDs, GTINs, MPNs and models as strings to preserve leading zeros. Optional variant, numeric packSize and string packUnit are explicit conflict guards.", "items": { "type": "object", "properties": { "id": { "title": "Reference ID", "description": "Customer-defined stable reference identifier.", "type": "string", "editor": "textfield" }, "brand": { "title": "Brand", "description": "Explicit product brand used with MPN or model.", "type": "string", "editor": "textfield" }, "gtin": { "title": "GTIN", "description": "Global trade item number entered as text to preserve leading zeros.", "type": "string", "editor": "textfield" }, "mpn": { "title": "MPN", "description": "Manufacturer part number entered as text.", "type": "string", "editor": "textfield" }, "model": { "title": "Model", "description": "Explicit manufacturer model identifier.", "type": "string", "editor": "textfield" }, "variant": { "title": "Variant", "description": "Explicit size, color or other variant label.", "type": "string", "editor": "textfield" }, "packSize": { "title": "Pack size", "description": "Explicit numeric quantity in the referenced pack.", "type": "number" }, "packUnit": { "title": "Pack unit", "description": "Explicit unit code for the referenced pack size.", "type": "string", "editor": "textfield" } } }, "default": [] }, "includeVendors": { "title": "Include Shopify vendors", "maxItems": 100, "type": "array", "description": "Optional exact public-catalog vendor allowlist, up to 100 names.", "items": { "type": "string" }, "default": [] }, "monitoringKey": { "title": "Monitoring key", "minLength": 1, "maxLength": 200, "type": "string", "description": "Stable customer-defined key for a monitor baseline.", "default": "default" }, "maxProductsPerStore": { "title": "Catalog products per store", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum source products read from each Shopify catalog before marking it partial.", "default": 100 }, "maxResults": { "title": "Delivered observations", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Maximum offer observations delivered and charged in this run.", "default": 25 }, "concurrency": { "title": "Concurrent public requests", "minimum": 1, "maximum": 16, "type": "integer", "description": "Maximum number of public source requests processed concurrently.", "default": 4 }, "maxPages": { "title": "Maximum catalog/product pages", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Maximum number of catalog pages requested from each configured source.", "default": 120 }, "maxBodyBytes": { "title": "Maximum response body bytes", "minimum": 1024, "maximum": 5242880, "type": "integer", "description": "Maximum accepted response size in bytes for each source request.", "default": 2097152 }, "requestTimeoutMs": { "title": "Per-request timeout (ms)", "minimum": 1000, "maximum": 30000, "type": "integer", "description": "Maximum time in milliseconds allowed for each source request.", "default": 15000 }, "maxRunSeconds": { "title": "Run time cap (seconds)", "minimum": 30, "maximum": 7200, "type": "integer", "description": "Internal runtime cap only. It does not change the platform timeout in Run options, which must be larger. The 240-second default leaves 60 seconds below the 300-second platform default. Larger inputs may require more memory.", "default": 240 } } }, "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 } } }, "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 } } } } } } } } } }