{ "openapi": "3.0.1", "info": { "title": "MAP Price Violation Monitor & Alerts", "description": "Monitor your product list across retailer sites and get alerted the moment a price drops below your MAP (minimum advertised price). Stateful: alerts only on new violations, deeper cuts and recoveries — never repeats. Works on Shopify, WooCommerce, BigCommerce, Magento and custom shops. GDPR-clean.", "version": "0.1", "x-build-id": "7g1XQb6aJvATZ5Ryi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lowlanddata~map-price-violation-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lowlanddata-map-price-violation-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/lowlanddata~map-price-violation-monitor/runs": { "post": { "operationId": "runs-sync-lowlanddata-map-price-violation-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/lowlanddata~map-price-violation-monitor/run-sync": { "post": { "operationId": "run-sync-lowlanddata-map-price-violation-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", "required": [ "products" ], "properties": { "products": { "title": "Products to monitor", "type": "array", "description": "REQUIRED. Your product list as JSON: one entry per retailer product page, each with url (the product page), mapPrice (your minimum advertised price), optional currency (ISO code, default USD) and optional label. Example: [{ \"url\": \"https://shop.example.com/products/widget\", \"mapPrice\": 129.95, \"label\": \"Widget Pro\" }]. Up to 500 products per run. Tip: the README has a copy-paste AI prompt that converts a pasted price list or spreadsheet into this JSON." }, "alertOn": { "title": "Alert on", "enum": [ "violations", "violations-and-recoveries" ], "type": "string", "description": "What counts as an alert. 'violations' alerts when a product newly drops below its MAP or an existing violation cuts deeper. 'violations-and-recoveries' additionally alerts when a violating product returns to or above MAP.", "default": "violations" }, "emitBaseline": { "title": "Emit baseline snapshot on first run", "type": "boolean", "description": "On the first run for a product, push its current price as a baseline item (flagged isBaseline, charged at the low baseline price). Turn off to seed silently: the first run then records state without pushing items.", "default": true }, "resetState": { "title": "Reset monitor state", "type": "boolean", "description": "Discard everything this monitor remembers and start over: the next run is a fresh baseline for every product. Use after large catalog or MAP policy changes.", "default": false }, "maxItems": { "title": "Max items per run", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Upper bound on items pushed per run. Alerts are pushed before baseline snapshots, so a low cap never hides a violation. Transitions that do not fit alert on the next run.", "default": 500 }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Named key-value store holding what the monitor has already seen. Use a different name per independent monitor (e.g. one per brand) so their memories never mix.", "default": "map-monitor-state" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy settings for fetching retailer pages. The default (datacenter) works for the covered long-tail shops.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }