{ "openapi": "3.0.1", "info": { "title": "Amazon Sponsored Ads Intelligence", "description": "Extract every Sponsored placement on page one of Amazon search for your keywords, with slot positions and a per-keyword advertiser roll-up. Shows which competitors bid hardest on which terms. Samples each keyword repeatedly. No login needed.", "version": "0.1", "x-build-id": "3VR587N7yRe37Plww" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zucchini_gopher_m2v~amazon-sponsored-ads-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zucchini_gopher_m2v-amazon-sponsored-ads-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/zucchini_gopher_m2v~amazon-sponsored-ads-tracker/runs": { "post": { "operationId": "runs-sync-zucchini_gopher_m2v-amazon-sponsored-ads-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/zucchini_gopher_m2v~amazon-sponsored-ads-tracker/run-sync": { "post": { "operationId": "run-sync-zucchini_gopher_m2v-amazon-sponsored-ads-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", "required": [ "keywords" ], "properties": { "keywords": { "title": "Keywords to monitor", "type": "array", "description": "Search terms to watch, e.g. [\"wireless earbuds\", \"yoga mat\"]. Each is searched on Amazon and every Sponsored placement on page one is extracted with its slot position.", "default": [], "items": { "type": "string" } }, "marketplace": { "title": "Marketplace", "enum": [ "com", "co.uk", "de", "fr", "it", "es", "ca", "com.au", "co.jp", "in" ], "type": "string", "description": "Amazon domain to search. Prices are forced into this marketplace's currency regardless of where the actor runs from.", "default": "com" }, "samplesPerKeyword": { "title": "Samples per keyword", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many times to search each keyword. Amazon auctions ad slots per impression, so one fetch is a single sample - measured density ranged from 0% to 21.7% of page-one slots across keywords. Sampling 3-5 times gives a far more reliable picture of who is bidding persistently rather than who won one impression.", "default": 3 }, "includeOrganic": { "title": "Include organic results", "type": "boolean", "description": "Also emit the non-sponsored results, so you can compare an advertiser's paid placement against the organic ranking on the same keyword. Off by default to keep the dataset focused on ads.", "default": false }, "includeSummary": { "title": "Include per-keyword summary", "type": "boolean", "description": "Emit one KEYWORD_SUMMARY row per keyword: sponsored share of page one, ad slot positions, unique advertised ASINs, and which ASINs appeared across the most samples - the 'who is bidding hardest' answer.", "default": true }, "maxResultsPerKeyword": { "title": "Max results per sample", "minimum": 0, "type": "integer", "description": "Cap results parsed from each search page. 0 means parse the whole page (Amazon returns roughly 16-60 results depending on the keyword).", "default": 0 }, "delaySeconds": { "title": "Delay between requests (seconds)", "minimum": 0, "maximum": 60, "type": "integer", "description": "Pause between searches and between samples. Amazon search is defended: most TLS fingerprints are rejected outright and CAPTCHAs are served to traffic it dislikes. Pacing is what keeps a run clean; this actor never solves CAPTCHAs.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "STRONGLY RECOMMENDED. Amazon search rejects most datacentre traffic and serves CAPTCHAs; a rotating residential proxy plus the built-in fingerprint ladder is what makes a multi-keyword run viable.", "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 } } } } } } } } } }