{ "openapi": "3.0.1", "info": { "title": "App Store Rank Tracker - Apple Keyword & Category Ranking (ASO)", "description": "Track an iOS app key word ranking position, category rank, rating and version with run-over-run deltas. Zero-auth Apple iTunes Search + RSS + Lookup APIs.", "version": "1.0", "x-build-id": "RfecEDXqbpHP6oLcE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/constant_quadruped~app-store-rank-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-constant_quadruped-app-store-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/constant_quadruped~app-store-rank-tracker/runs": { "post": { "operationId": "runs-sync-constant_quadruped-app-store-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/constant_quadruped~app-store-rank-tracker/run-sync": { "post": { "operationId": "run-sync-constant_quadruped-app-store-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": { "appIds": { "title": "App Store app IDs or URLs", "type": "array", "description": "Apple App Store numeric IDs (e.g. 281796108) or full app URLs (e.g. https://apps.apple.com/us/app/evernote/id281796108) for the apps you want to track.", "items": { "type": "string" } }, "keywords": { "title": "Keywords to track", "type": "array", "description": "Search keywords/phrases to look up each app's ranking position for (e.g. 'notes app', 'todo list', 'project management'). The actor reports the app's 1-based position in App Store search results for each keyword.", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms to resolve to app IDs (optional)", "type": "array", "description": "App names to resolve to App Store IDs automatically via the iTunes Search API when you don't have the numeric ID. Each resolved app is then tracked like an appId.", "items": { "type": "string" } }, "country": { "title": "Storefront country", "type": "string", "description": "2-letter App Store storefront code. Rankings are storefront-specific. Default: us.", "default": "us" }, "charts": { "title": "Category charts to check", "type": "array", "description": "Which top-charts to look the app up in for category rank: topfree, toppaid, topgrossing. The app is matched within its own primary genre chart.", "default": [ "topfree" ], "items": { "type": "string" } }, "includeCategoryRank": { "title": "Include category (top-charts) rank", "type": "boolean", "description": "Also look up each app's position in its primary-genre top-charts feed(s). Turn off to track keyword rankings only.", "default": true }, "searchLimit": { "title": "Search depth per keyword (10-200)", "minimum": 10, "maximum": 200, "type": "integer", "description": "How many App Store search results to scan per keyword when locating the app. Higher = catches lower-ranked apps but slightly slower. Apple caps at 200.", "default": 100 }, "categoryChartLimit": { "title": "Category chart depth (50-200)", "minimum": 50, "maximum": 200, "type": "integer", "description": "How many top-chart entries to scan when locating the app's category rank. Apple caps RSS top-charts at 200.", "default": 200 } } }, "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 } } } } } } } } } }