{ "openapi": "3.0.1", "info": { "title": "Amazon Keyword Rank Tracker - Organic & Sponsored ASIN Rank", "description": "Amazon keyword rank tracker: see where each ASIN ranks for a search term, organic and sponsored, with rank history and Slack/Discord alerts. 11 marketplaces.", "version": "0.1", "x-build-id": "vzB2hKZHE3kVDTUnV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/deanko~amazon-keyword-rank-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-deanko-amazon-keyword-rank-tracker", "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/deanko~amazon-keyword-rank-tracker/runs": { "post": { "operationId": "runs-sync-deanko-amazon-keyword-rank-tracker", "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/deanko~amazon-keyword-rank-tracker/run-sync": { "post": { "operationId": "run-sync-deanko-amazon-keyword-rank-tracker", "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": { "keywords": { "title": "Keywords", "type": "array", "description": "Amazon search keywords to track, e.g. `yoga mat`. Each keyword is checked across the number of search pages set below.", "default": [ "yoga mat" ], "items": { "type": "string" } }, "asins": { "title": "ASINs to track (yours and competitors)", "type": "array", "description": "ASINs or product URLs whose rank you want to follow, yours and competitors'. Leave empty to record the organic rank of every product found (a full snapshot of the results).", "items": { "type": "string" } }, "marketplace": { "title": "Marketplace", "enum": [ "com", "ca", "co.uk", "de", "fr", "it", "es", "co.jp", "com.au", "in", "com.mx" ], "type": "string", "description": "Amazon store to check. Search results differ by country, so the proxy country is matched to the marketplace automatically.", "default": "com" }, "maxPages": { "title": "Search pages to check per keyword", "minimum": 1, "maximum": 7, "type": "integer", "description": "How deep to look per keyword. Each page has roughly 16-60 results and is one billable search page. 3 pages usually covers the top 100-150 organic results.", "default": 3 }, "alertOnRankChange": { "title": "Alert when rank moves by at least", "minimum": 0, "type": "integer", "description": "Alert when an ASIN's organic rank moves by at least this many positions. Entering or dropping out of the checked pages always alerts. 0 = only enter/drop-out alerts.", "default": 5 }, "webhookUrl": { "title": "Alert webhook URL (Slack, Discord or any)", "type": "string", "description": "Optional. Paste a Slack incoming-webhook URL, a Discord webhook URL or any HTTPS endpoint. One message per run lists all alerts. The JSON body has `text` (Slack), `content` (Discord) and the full `alerts` array." }, "onlyChanges": { "title": "Output only changes", "type": "boolean", "description": "If on, unchanged and not-found rows are not written to the dataset.", "default": false }, "trackerName": { "title": "Tracker name", "type": "string", "description": "Rank history is stored per tracker name in your Apify account and survives between runs. Use one name per client or project.", "default": "default" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Residential proxy recommended; Amazon blocks datacenter IPs quickly. Country is matched to the marketplace automatically.", "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 }, "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 } } } } } } } } } }