{ "openapi": "3.0.1", "info": { "title": "US MAP Retail Evidence", "description": "Process supplied US retail catalog evidence into deterministic MAP, availability, baseline, and review findings.", "version": "0.1", "x-build-id": "FY6LuB63eCdc3M9hV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zinin~us-map-retail-evidence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zinin-us-map-retail-evidence", "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/zinin~us-map-retail-evidence/runs": { "post": { "operationId": "runs-sync-zinin-us-map-retail-evidence", "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/zinin~us-map-retail-evidence/run-sync": { "post": { "operationId": "run-sync-zinin-us-map-retail-evidence", "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": [ "schemaVersion", "requestId", "watchId", "watchUniverse" ], "properties": { "schemaVersion": { "title": "Contract version", "enum": [ "1.0" ], "type": "string", "description": "The supported input contract version.", "default": "1.0" }, "requestId": { "title": "Request ID", "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "minLength": 1, "maxLength": 128, "type": "string", "description": "Use auto for one idempotency scope per trusted Apify Actor run; explicit IDs preserve replay idempotency.", "default": "auto" }, "watchId": { "title": "Baseline watch ID", "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "minLength": 1, "maxLength": 128, "type": "string", "description": "Stable watch identity used to scope the deletion-safe baseline.", "default": "lego-watch" }, "watchUniverse": { "title": "Configured watch universe", "minItems": 1, "maxItems": 100, "type": "array", "description": "Exact identity keys expected in the closed snapshot; this is used for deletion-safe baseline comparison.", "items": { "type": "string", "pattern": "^(productId|upc|asin|usItemId|tcin):.+$" }, "default": [ "tcin:16747749" ] }, "rows": { "title": "Canonical inline rows", "minItems": 1, "maxItems": 100, "type": "array", "description": "One to 100 supplied rows; use this or datasetId.", "items": { "type": "object" }, "default": [ { "adapter": "target", "sourceRecordId": "target-16747749", "sourceName": "target_probe", "observedAt": "2026-08-06T11:03:21.195Z", "data": { "tcin": "16747749", "upc": "673419233606", "productTitle": "LEGO Classic Large Creative Brick Box", "brand": "LEGO", "price": null, "availability": null, "url": "https://www.target.com/p/example/-/A-16747749" }, "mapCents": 2999 } ] }, "datasetId": { "title": "Buyer Dataset ID", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,99}$", "type": "string", "description": "Read-only Dataset selected by the buyer; one bounded first page is read." }, "datasetCoverage": { "title": "Closed Dataset coverage proof", "required": [ "closed", "expectedItems" ], "type": "object", "description": "Required for Dataset input. The declared count must equal the bounded read and closed must be true.", "properties": { "closed": { "title": "Closed Dataset", "description": "Confirm that the bounded Dataset read is complete.", "editor": "checkbox", "type": "boolean" }, "expectedItems": { "title": "Expected Dataset items", "description": "The exact number of items in the closed Dataset read.", "editor": "number", "type": "integer", "minimum": 0, "maximum": 100 } }, "additionalProperties": false }, "openrouterApiKey": { "title": "Optional BYOK key", "type": "string", "description": "Secret caller-owned key used only for one explanation request." }, "options": { "title": "Options", "type": "object", "description": "Optional bounded processing and explanation settings.", "properties": { "maxItems": { "title": "Maximum items", "description": "Maximum accepted rows to process, from 1 to 100.", "editor": "number", "type": "integer", "minimum": 1, "maximum": 100, "default": 100, "prefill": 100 }, "explanation": { "title": "Explanation mode", "description": "Keep explanations off or request one BYOK explanation.", "editor": "select", "type": "string", "enum": [ "off", "byok" ], "default": "off", "prefill": "off" }, "analysisModel": { "title": "Analysis model", "description": "Optional OpenRouter model identifier used only in BYOK mode.", "editor": "textfield", "type": "string", "nullable": true, "maxLength": 200, "default": null } }, "default": { "maxItems": 100, "explanation": "off", "analysisModel": null }, "additionalProperties": false } } }, "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 } } } } } } } } } }