{ "openapi": "3.0.1", "info": { "title": "Shopify Competitor Monitor: Products, Prices & Stock Changes", "description": "📊 Track Shopify competitors daily. Detect product launches, price cuts, discounts, availability, theme and app changes, and catalog trends in one intelligence report.", "version": "0.1", "x-build-id": "zwdCSaTBmBs5Use7d" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/feeng~shopify-competitor-intelligence-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-feeng-shopify-competitor-intelligence-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/feeng~shopify-competitor-intelligence-monitor/runs": { "post": { "operationId": "runs-sync-feeng-shopify-competitor-intelligence-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/feeng~shopify-competitor-intelligence-monitor/run-sync": { "post": { "operationId": "run-sync-feeng-shopify-competitor-intelligence-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": [ "stores" ], "properties": { "stores": { "title": "Shopify stores", "type": "array", "description": "Store homepages or domains to monitor. The Actor reads public Shopify storefront endpoints directly.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Maximum products per store", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Hard cap for products fetched from each store. Use 250 for a fast daily pulse or a higher number for deeper catalog analysis.", "default": 250 }, "compareWithPrevious": { "title": "Compare with previous run", "type": "boolean", "description": "Compare this catalog snapshot with the latest saved snapshot for the same store.", "default": true }, "saveSnapshot": { "title": "Save snapshot", "type": "boolean", "description": "Save this run so the next scheduled run can identify changes and trends.", "default": true }, "historyDays": { "title": "History days", "minimum": 2, "maximum": 365, "type": "integer", "description": "Number of daily summary points retained for trend reporting. Full catalog data is retained only for the newest comparison baseline.", "default": 90 }, "includeProducts": { "title": "Include product records", "type": "boolean", "description": "Include normalized product records in each dataset item. Turn off for lightweight daily monitoring.", "default": true }, "maxProductsInOutput": { "title": "Maximum products in output", "minimum": 0, "maximum": 2000, "type": "integer", "description": "Cap product records included in output while retaining the full fetched snapshot for change detection.", "default": 250 }, "includeHtmlReport": { "title": "Generate HTML report", "type": "boolean", "description": "Save a visual competitor report as REPORT.html in the run key-value store.", "default": true }, "includeTechStack": { "title": "Detect theme, apps, and tracking", "type": "boolean", "description": "Detect public Shopify theme, common marketing apps, reviews, support, subscriptions, and tracking signals. Changes are compared between runs.", "default": true }, "fetchTimeoutSecs": { "title": "Request timeout in seconds", "minimum": 5, "maximum": 120, "type": "integer", "description": "Maximum duration of a single store request.", "default": 30 }, "retryCount": { "title": "Retries per request", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries transient request failures before returning an error for the store.", "default": 2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify Proxy configuration. The Actor attempts public endpoints directly first and uses the selected proxy when configured.", "default": { "useApifyProxy": true } }, "snapshotStoreName": { "title": "Snapshot store name", "type": "string", "description": "Named key-value store used to preserve snapshots between scheduled runs.", "default": "shopify-competitor-intelligence-history" } } }, "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 } } } } } } } } } }