{ "openapi": "3.0.1", "info": { "title": "Amazon Product Research & Niche Analyzer", "description": "Compare Amazon niches using your product data or an Apify Dataset. Analyze brand competition, review barriers, prices and demand signals. $0.10 per qualifying analysis; no analysis fee for demo or insufficient data. Does not scrape Amazon.", "version": "0.1", "x-build-id": "b3xzq6grghKk9Q569" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jin_data_tools~amazon-niche-opportunity-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jin_data_tools-amazon-niche-opportunity-auditor", "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/jin_data_tools~amazon-niche-opportunity-auditor/runs": { "post": { "operationId": "runs-sync-jin_data_tools-amazon-niche-opportunity-auditor", "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/jin_data_tools~amazon-niche-opportunity-auditor/run-sync": { "post": { "operationId": "run-sync-jin_data_tools-amazon-niche-opportunity-auditor", "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": "Data source mode", "enum": [ "demo", "products", "dataset" ], "type": "string", "description": "Choose bundled demo data, product rows you supply, or an existing dataset. This Actor does not scrape Amazon.", "default": "demo" }, "keyword": { "title": "Search keyword / niche label", "type": "string", "description": "Required for 'products' and 'dataset' modes. Used only as a label in the output -- never sent anywhere." }, "marketplace": { "title": "Amazon marketplace", "type": "string", "description": "Amazon locale code, e.g. 'com', 'co.uk', 'de'. Recorded in output only; the Actor does not query Amazon.", "default": "com" }, "maxProducts": { "title": "Max products to analyze", "minimum": 1, "maximum": 200, "type": "integer", "description": "Explicit cap on rows analyzed. Hard platform ceiling is 200 regardless of this value; requests above the ceiling are capped and disclosed in actor_meta.max_products_capped, never silently truncated without notice." }, "demoFixture": { "title": "Demo fixture name (mode=demo only)", "enum": [ "sufficient_market", "owala_insufficient" ], "type": "string", "description": "Choose a bundled example to inspect the output; demo results are not live market research.", "default": "sufficient_market" }, "products": { "title": "Product rows (mode=products only)", "type": "array", "description": "Raw product rows you already have (e.g. from your own Amazon-data source). Required, non-empty, when mode=products. Missing optional fields must be omitted or null -- never fabricate a value to fill a gap." }, "sourceDatasetId": { "title": "Apify Dataset ID (mode=dataset only)", "type": "string", "description": "Select your existing product dataset. This run receives read-only access to that selected dataset; the Actor does not start a scraper or modify the source." } } }, "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 } } } } } } } } } }