{ "openapi": "3.0.1", "info": { "title": "Amazon Review Analyzer & Product Opportunity Finder", "description": "Scrape Amazon reviews into a product-opportunity verdict: complaint clusters, unmet needs & a go/no-go score. Pay-per-use, never billed for empty runs.", "version": "0.1", "x-build-id": "vjt58QgfMZKOh3crF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/catandgoose~amazon-review-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-catandgoose-amazon-review-intelligence", "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/catandgoose~amazon-review-intelligence/runs": { "post": { "operationId": "runs-sync-catandgoose-amazon-review-intelligence", "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/catandgoose~amazon-review-intelligence/run-sync": { "post": { "operationId": "run-sync-catandgoose-amazon-review-intelligence", "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": [ "mode" ], "properties": { "mode": { "title": "Input mode", "enum": [ "snapshot", "cookies", "dataset" ], "type": "string", "description": "How to get the reviews. 'snapshot' = anonymous product-page scrape (top reviews + rating histogram + Amazon's 'Customers say' summary), zero setup. 'cookies' = full review pagination using your own Amazon session cookies. 'dataset' = analyze reviews already collected in an Apify dataset (from any scraper).", "default": "snapshot" }, "asins": { "title": "ASINs or product URLs", "type": "array", "description": "Amazon ASINs (e.g. B09B8V1LZ3) or full product URLs. Used by snapshot and cookies modes.", "items": { "type": "string" } }, "marketplace": { "title": "Marketplace", "enum": [ "com", "co.uk", "de", "ca", "com.au", "fr", "es", "it" ], "type": "string", "description": "Amazon marketplace domain to scrape.", "default": "com" }, "runAiAnalysis": { "title": "Generate product-opportunity verdict", "type": "boolean", "description": "Turn the review corpus into complaint clusters, unmet-need gaps, and a go/no-go opportunity verdict. Turn off for scrape-only runs.", "default": true }, "maxReviews": { "title": "Max reviews to scrape per ASIN (cookies mode)", "minimum": 10, "maximum": 10000, "type": "integer", "description": "Upper bound on reviews collected per product in cookies mode. Snapshot mode returns whatever the product page exposes (typically 8-100).", "default": 500 }, "maxReviewsAnalyzed": { "title": "Max reviews analyzed per ASIN", "minimum": 50, "maximum": 5000, "type": "integer", "description": "Caps analysis cost. Complaint themes converge fast, so 300-1000 high-signal reviews usually capture every theme. Reviews above this cap are billed per 1,000 via the analysis-overflow event.", "default": 1000 }, "maxAiSpendUsd": { "title": "Max analysis spend for this run (USD)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Safety ceiling on this run's estimated analysis cost. Once hit, remaining products in a batch are scraped without an opportunity verdict rather than continuing to spend. Raise this for large multi-ASIN batches.", "default": 5 }, "competitorAsins": { "title": "Competitor ASINs (optional)", "type": "array", "description": "Optional competitor products for a side-by-side verdict. Each competitor is scraped and analyzed like a primary ASIN.", "items": { "type": "string" } }, "datasetId": { "title": "Source dataset (dataset mode)", "type": "string", "description": "Apify dataset containing review rows to analyze. Used only when mode = 'dataset'. Pick one of your datasets, or paste a dataset ID." }, "datasetReviewField": { "title": "Review text field name", "type": "string", "description": "The field in each dataset row that holds the review text (e.g. 'reviewText', 'body', 'text').", "default": "reviewText" }, "datasetRatingField": { "title": "Rating field name", "type": "string", "description": "Optional field holding the star rating (e.g. 'rating', 'stars').", "default": "rating" }, "sessionCookies": { "title": "Amazon session cookies (cookies mode)", "type": "string", "description": "Your own Amazon session cookies, used only in cookies mode to paginate the full review list. Paste the raw Cookie header string or JSON array of {name,value} pairs exported from your browser. WARNING: these come from your logged-in Amazon account — high-volume pagination may trigger Amazon account checks. Use an account you're comfortable with, and never share this value." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxies strongly recommended for Amazon. Defaults to Apify residential.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }