{ "openapi": "3.0.1", "info": { "title": "App Store Intelligence Pro - ASO & Rank Tracker", "description": "Cross-store (Apple App Store + Google Play) ASO & competitor research: keyword difficulty + popularity, rank tracking, top charts, full metadata and AI review insights.", "version": "1.0", "x-build-id": "hnupKUpoAKOHfygO7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/webdatalabs~app-store-intelligence-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-webdatalabs-app-store-intelligence-pro", "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/webdatalabs~app-store-intelligence-pro/runs": { "post": { "operationId": "runs-sync-webdatalabs-app-store-intelligence-pro", "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/webdatalabs~app-store-intelligence-pro/run-sync": { "post": { "operationId": "run-sync-webdatalabs-app-store-intelligence-pro", "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": [ "mode" ], "properties": { "mode": { "title": "What do you want", "enum": [ "keyword-intelligence", "keyword-rankings", "app-details", "top-charts", "reviews" ], "type": "string", "description": "Pick the job. Keyword intelligence returns a difficulty + popularity score per keyword (the flagship). Keyword rankings returns which apps rank for each keyword. App details returns full metadata. Top charts returns the store rankings. Reviews returns customer reviews (optionally AI-summarized).", "default": "keyword-intelligence" }, "query": { "title": "Keywords or apps", "type": "array", "description": "For keyword modes: search terms (e.g. \"vpn\", \"habit tracker\"). For app-details / reviews: App Store or Google Play URLs, Apple track IDs (e.g. 310633997), or Android package names (e.g. com.whatsapp). For top charts: leave empty (or a Google Play category name). Pasted store URLs are accepted directly.", "default": [], "items": { "type": "string" } }, "stores": { "title": "Stores", "type": "array", "description": "Which store(s) to query.", "items": { "type": "string", "enum": [ "apple", "google-play" ], "enumTitles": [ "Apple App Store", "Google Play" ] }, "default": [ "apple", "google-play" ] }, "countries": { "title": "Countries", "type": "array", "description": "ISO country codes to query, e.g. us, gb, de. Popularity and rankings are country-specific.", "default": [ "us" ], "items": { "type": "string" } }, "maxResults": { "title": "Max results per query", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Upper bound per keyword/app/country. Reviews are capped by the store (Apple ~500/app/country).", "default": 100 }, "aiEnrichment": { "title": "AI review insights", "type": "boolean", "description": "Reviews mode only. Adds AI-mined themes, sentiment, top praises and complaints per app (gpt-4o-mini). Billed per app at the AI rate.", "default": false }, "openaiApiKey": { "title": "OpenAI API key (optional)", "type": "string", "description": "Optional. Only used when AI review insights is on. Falls back to the built-in key if omitted." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Datacenter proxy is enough for Apple and Google Play. Switch to Residential only if you see blocks at high volume.", "default": { "useApifyProxy": true, "apifyProxyGroups": [] } }, "debug": { "title": "Debug logging", "type": "boolean", "description": "Verbose logs for troubleshooting.", "default": false } } }, "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 } } } } } } } } } }