{ "openapi": "3.0.1", "info": { "title": "App Store & Google Play Keyword Rank Tracker (ASO)", "description": "Track where your apps rank for each keyword on the App Store and Google Play, in many countries per run: one row per keyword, country, store and app with its rank (or NOT_IN_RESULTS), the top competitors, and the change since your last run. $1.50 per 1,000 rank rows + $0.001/run.", "version": "0.1", "x-build-id": "FKskDUEc1NUDJQtSJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tagadanar~app-keyword-rank-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tagadanar-app-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/tagadanar~app-keyword-rank-tracker/runs": { "post": { "operationId": "runs-sync-tagadanar-app-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/tagadanar~app-keyword-rank-tracker/run-sync": { "post": { "operationId": "run-sync-tagadanar-app-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", "required": [ "keywords" ], "properties": { "keywords": { "title": "Keywords", "type": "array", "description": "Search phrases to check, as users type them in the store (e.g. \"meditation\", \"sleep sounds\"). Up to 300 per run. Each keyword is searched once per country and store.", "items": { "type": "string" } }, "apps": { "title": "Apps to track", "type": "array", "description": "Your apps and your competitors'. App Store: the numeric id (493145008) or the apps.apple.com link. Google Play: the package (com.calm.android) or the play.google.com link. A package-style id is also checked as an App Store bundle id. Every app gets a row per keyword, country and store: its rank, or NOT_IN_RESULTS. Leave empty to get the top apps only.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Two-letter country codes of the storefronts to check (us, gb, de, fr, jp, br…). Up to 60 per run. Default: us.", "default": [ "us" ], "items": { "type": "string" } }, "store": { "title": "Store", "enum": [ "both", "apple", "google" ], "type": "string", "description": "Which store to search. A store is only searched when one of your apps can live there or Top apps per keyword is above 0.", "default": "both" }, "topN": { "title": "Top apps per keyword", "minimum": 0, "maximum": 100, "type": "integer", "description": "Also return the first N apps that rank for each keyword, as competitor rows (each is one charged row; a tracked app is never returned twice). Default: 0 when you track apps, 10 when you track none. Google Play's web search lists about 20-50 apps per keyword." }, "searchDepth": { "title": "Search depth", "minimum": 1, "maximum": 200, "type": "integer", "description": "How deep to look for your apps on the App Store (Apple's search API returns up to about 190 of the 200 positions asked). Google Play's web search lists about 20-50 apps, whatever the setting. An app not found within the depth gets rank null and NOT_IN_RESULTS.", "default": 200 }, "language": { "title": "Google Play language", "type": "string", "description": "Optional language code for Google Play searches (en, de, pt-BR…). Google Play ranks differently per interface language; by default each country uses its main language (de for Germany, ja for Japan, en where unlisted). The App Store always uses the storefront's own language." }, "trackChanges": { "title": "Track rank changes", "type": "boolean", "description": "Compare every rank with the previous run of the same watch and fill previousRank, rankChange and changeStatus (UP, DOWN, SAME, ENTERED, DROPPED_OUT, FIRST_CHECK). Schedule the actor daily for a rank history.", "default": true }, "historyName": { "title": "Watch name (optional)", "type": "string", "description": "By default a watch is its exact set of keywords, apps, countries and settings: change any of them and the comparison starts fresh. Give a name (e.g. \"my-app-us\") to keep comparing ranks while you add or remove keywords." } } }, "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 } } } } } } } } } }