{ "openapi": "3.0.1", "info": { "title": "Cross-Store ASO Keyword Rank Monitor", "description": "Monitor Apple App Store and Google Play keyword rankings across countries. Detect rank gains, drops, Top 3/10 changes, competitor overtakes, and #1 changes automatically.", "version": "0.1", "x-build-id": "SbNuPhxaY7VakumZ5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/herazur~cross-store-aso-keyword-rank-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-herazur-cross-store-aso-keyword-rank-monitor", "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/herazur~cross-store-aso-keyword-rank-monitor/runs": { "post": { "operationId": "runs-sync-herazur-cross-store-aso-keyword-rank-monitor", "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/herazur~cross-store-aso-keyword-rank-monitor/run-sync": { "post": { "operationId": "run-sync-herazur-cross-store-aso-keyword-rank-monitor", "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": [ "apps", "keywords", "countries" ], "properties": { "apps": { "title": "Apps", "minItems": 1, "maxItems": 50, "type": "array", "description": "Tracked own and competitor apps. Provide stable store IDs; at least one ID is required per app.", "items": { "type": "object", "properties": { "name": { "type": "string", "title": "Name", "description": "Your label for this tracked app.", "minLength": 1 }, "role": { "type": "string", "title": "Role", "description": "Whether this is your app or an explicitly tracked competitor.", "enum": [ "own", "competitor" ], "enumTitles": [ "Own app", "Competitor" ] }, "appStoreId": { "type": "string", "title": "Apple App Store ID", "description": "Numeric ID from the Apple App Store URL.", "pattern": "^[0-9]+$" }, "googlePlayId": { "type": "string", "title": "Google Play package ID", "description": "Package name from the Google Play URL, such as com.example.app." } }, "required": [ "name", "role" ] } }, "keywords": { "title": "Keywords", "minItems": 1, "maxItems": 50, "type": "array", "description": "Keyword phrases to check.", "items": { "type": "string", "minLength": 1 } }, "countries": { "title": "Countries", "minItems": 1, "maxItems": 10, "type": "array", "description": "Two-letter storefront/market codes such as us, gb, or de.", "items": { "type": "string", "pattern": "^[A-Za-z]{2}$" } }, "stores": { "title": "Stores", "type": "array", "description": "Storefronts to monitor.", "items": { "type": "string", "enum": [ "appstore", "googleplay" ] }, "default": [ "appstore", "googleplay" ] }, "onlyChanges": { "title": "Only changes", "type": "boolean", "description": "Return incidents only. Disable for one normalized snapshot row per tracked app and keyword market.", "default": true }, "googlePlayLanguage": { "title": "Google Play language", "type": "string", "description": "Language code used for Google Play public search, for example en or de.", "default": "en" }, "maxResultsPerKeyword": { "title": "Search depth", "minimum": 1, "maximum": 30, "type": "integer", "description": "Maximum results checked per keyword market. Google Play public search currently limits reliable HTTP depth, so the MVP maximum is 30.", "default": 30 }, "minimumRankChange": { "title": "Minimum rank movement", "minimum": 1, "maximum": 30, "type": "integer", "description": "Minimum movement for ordinary RANK_GAIN/RANK_DROP events. Result and Top 3/10 boundary events are never suppressed.", "default": 2 } } }, "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 } } } } } } } } } }