{ "openapi": "3.0.1", "info": { "title": "ASO Keyword Rank Tracker: App Store & Google Play", "description": "Track where any app ranks for any keyword on BOTH stores, in any country, in one dataset. Rank, rating, installs, developer, price and Apple top chart position, plus a free row naming the tracked apps that did not rank. No API key, no proxy.", "version": "0.1", "x-build-id": "Jl8AtWY2pVMH2aKWG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/themineworks~aso-keyword-rank-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-themineworks-aso-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/themineworks~aso-keyword-rank-tracker/runs": { "post": { "operationId": "runs-sync-themineworks-aso-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/themineworks~aso-keyword-rank-tracker/run-sync": { "post": { "operationId": "run-sync-themineworks-aso-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": "Search terms to check, exactly as a user would type them into the store search box.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Two letter storefront codes such as us, gb, in, de, br, jp. Rankings differ sharply by country, so this is where most of the value is. One search is run per keyword per country per store.", "items": { "type": "string" } }, "stores": { "title": "Stores", "type": "array", "description": "Which stores to check: appstore, googleplay, or both. Leave empty for both.", "items": { "type": "string" } }, "trackedApps": { "title": "Apps you are tracking", "type": "array", "description": "Your app and your competitors. Use the Android package name (com.example.app) or the iOS bundle id or numeric App Store id. Matched rows are flagged, and any tracked app that does NOT rank is named in a free keyword summary row.", "items": { "type": "string" } }, "trackedDeveloper": { "title": "Tracked developer", "type": "string", "description": "Flag every app whose developer name contains this text. Useful for measuring a publisher's share of the results page." }, "trackedOnly": { "title": "Only deliver tracked apps", "type": "boolean", "description": "Deliver only rows matching a tracked app or tracked developer. Turn this on for cheap daily rank monitoring, off when you want the full competitive results page.", "default": false }, "maxResultsPerKeyword": { "title": "Results per search", "minimum": 1, "maximum": 200, "type": "integer", "description": "How deep to record the results page. The App Store returns up to 200, Google Play returns about 30 per search. This is your main cost control.", "default": 25 }, "includeTopCharts": { "title": "Join Apple top charts", "type": "boolean", "description": "Add each App Store app's position in Apple's public top chart for that country, so keyword rank and chart rank sit in the same row. One extra request per country for the whole run.", "default": true }, "chartKind": { "title": "Chart to join", "enum": [ "top-free", "top-paid" ], "type": "string", "description": "Which Apple chart to join against.", "default": "top-free" }, "language": { "title": "Google Play language", "type": "string", "description": "Language code for Google Play results, for example en, de, pt. The App Store uses the country storefront's own language automatically.", "default": "en" } } }, "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 } } } } } } } } } }