{ "openapi": "3.0.1", "info": { "title": "Price Monitoring API - Retailer Offers, Prices and Availability", "description": "Price monitoring export: every retailer and marketplace offer for your products per data update, with offer price, shipping, availability, offer URL, your own price, price gap and minimum price breaches, plus update dates and report columns, from the Dealavo API v3. Read only. Bring your own key.", "version": "0.1", "x-build-id": "D8dELy93b7AZoj51R" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~retailer-price-monitoring-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-retailer-price-monitoring-api", "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/nabeelbaghoor~retailer-price-monitoring-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-retailer-price-monitoring-api", "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/nabeelbaghoor~retailer-price-monitoring-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-retailer-price-monitoring-api", "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": { "mode": { "title": "What to read", "enum": [ "offers", "updates", "columns" ], "type": "string", "description": "Retailer offers reads, for each data update, every retailer and marketplace offer matched to your products, and needs nothing else, so it is the default. Update dates lists when your data was refreshed. Available columns lists the report columns your account can request.", "default": "offers" }, "latestUpdates": { "title": "Latest updates", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Retailer offers only: how many of the most recent data updates to read when no date range is given. 1 reads only the latest snapshot. The update dates mode lists every update when no date range is given.", "default": 1 }, "fromDate": { "title": "From date", "type": "string", "description": "Retailer offers and update dates: read every update on or after this day, as YYYY-MM-DD, or after this exact update time, as YYYY_MM_DD_HH_MM. Overrides latest updates." }, "toDate": { "title": "To date", "type": "string", "description": "Retailer offers and update dates: read every update on or before this day, as YYYY-MM-DD, or before this exact update time, as YYYY_MM_DD_HH_MM. Overrides latest updates." }, "columns": { "title": "Report columns", "type": "array", "description": "Retailer offers only: the report columns to read, one per line, with the exact names the available columns mode lists, such as Id, Article, Retailer, Retailer price, Availability, Price and Url. Leave empty to read every column the account has.", "items": { "type": "string" } }, "onlyAvailableOffers": { "title": "Available offers only", "type": "boolean", "description": "Retailer offers only: ask the provider for currently available offers only, through its only_available_offers setting.", "default": false }, "retailers": { "title": "Only these retailers", "type": "array", "description": "Retailer offers only: keep only offers whose retailer name contains one of these, one per line, such as allegro.pl or mediaexpert. Applied to the provider's answer, and needs the Retailer column.", "items": { "type": "string" } }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop after this many rows. One update holds one row per product per retailer offer, often tens of thousands for a full catalogue.", "default": 1000 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 60, "type": "integer", "description": "Pacing ceiling for calls to the provider, which allows 60 requests per minute. Rate limited answers are retried after the wait the provider asks for.", "default": 50 }, "accountId": { "title": "Account ID", "type": "string", "description": "Your own account identifier, the account_id your provider issued with API access. Leave blank to use the DATA_API_ACCOUNT_ID environment secret instead." }, "apiKey": { "title": "API key", "type": "string", "description": "Your own API key, the api_key your provider issued with API access. This actor is bring-your-own-key and never ships one. Leave blank to use the DATA_API_KEY environment secret instead. It is never written to a row or the log." } } }, "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 } } } } } } } } } }