{ "openapi": "3.0.1", "info": { "title": "Amazon Seller Analyzer — Bulk Product CSV API", "description": "Analyze sampled Amazon seller products and price signals; sales and revenue scenarios are estimates. Bulk export: JSON, CSV, Excel and API. PPE: from $2/1K product analyses; start fee, usage extra.", "version": "0.7", "x-build-id": "5nO701IRRHFbZRZRE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apivault_labs~amazon-seller-revenue-strategy-analyzer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apivault_labs-amazon-seller-revenue-strategy-analyzer", "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/apivault_labs~amazon-seller-revenue-strategy-analyzer/runs": { "post": { "operationId": "runs-sync-apivault_labs-amazon-seller-revenue-strategy-analyzer", "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/apivault_labs~amazon-seller-revenue-strategy-analyzer/run-sync": { "post": { "operationId": "run-sync-apivault_labs-amazon-seller-revenue-strategy-analyzer", "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": { "sellerUrls": { "title": "Seller profile URLs", "maxItems": 20, "type": "array", "description": "Add Amazon seller profile URLs that contain a seller parameter, for example an /sp?seller=... URL.", "items": { "type": "string" } }, "sellerIds": { "title": "Seller IDs", "maxItems": 20, "type": "array", "description": "Add Amazon merchant IDs directly. A seller ID normally contains 13–14 uppercase letters and numbers.", "items": { "type": "string" } }, "marketplace": { "title": "Amazon marketplace", "enum": [ "us", "uk", "de", "fr", "es", "it", "ca", "mx", "in" ], "type": "string", "description": "Choose the marketplace where the seller operates. This controls catalog discovery, local prices, and output currency.", "default": "us" }, "maxProductsPerSeller": { "title": "Products per seller", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum analyzed products per seller (1–10000). Default5. Page/time/spending limits can return a smaller partial sample; this is not total seller turnover.", "default": 5 }, "includeOffers": { "title": "Inspect offers and Buy Box", "type": "boolean", "description": "Inspect publicly visible offer and Buy Box information for better attribution of listing demand to the target seller.", "default": true }, "trackStrategy": { "title": "Track changes between runs", "type": "boolean", "description": "Save an observation baseline and compare visible price, rank, availability, promotion, and seller-position signals on later runs.", "default": true }, "maxConcurrency": { "title": "Processing concurrency", "minimum": 1, "maximum": 4, "type": "integer", "description": "Number of products processed in parallel. The load-tested value balances speed and marketplace reliability.", "default": 2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Residential Proxy is recommended for reliable marketplace access. Proxy traffic is billed by Apify as platform usage.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "startPage": { "title": "Starting catalog page", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Use SUMMARY seller nextInput for a continuation. Search ordering can change between runs.", "default": 1 }, "startOffset": { "title": "Starting offset within page", "minimum": 0, "maximum": 500, "type": "integer", "description": "Number of already observed valid catalog cards to skip on startPage.", "default": 0 }, "maxPages": { "title": "Maximum catalog pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Upper bound for source pages per seller; reaching the limit is partial coverage.", "default": 20 }, "snapshotStoreId": { "title": "Monitoring key-value store ID", "type": "string", "description": "Optional store ID in your own Apify account, accessible to this run. Leave empty to use a named store scoped to workflowId." }, "workflowId": { "title": "Monitoring workflow", "pattern": "^[A-Za-z0-9_-]{1,64}$", "type": "string", "description": "Separate independent monitors. Scope is marketplace + seller + workflow; keep consistent inputs for comparisons.", "default": "default" } } }, "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 } } } } } } } } } }