{ "openapi": "3.0.1", "info": { "title": "Shopify App Store Keyword Rank Tracker & Scraper", "description": "Track your Shopify app's keyword rankings and competitors in App Store search daily. Also scrapes app details, pricing plans, reviews and categories.", "version": "0.2", "x-build-id": "yvM4CDKT6Q81rLe4V" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/carmentara~shopify-app-intel/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-carmentara-shopify-app-intel", "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/carmentara~shopify-app-intel/runs": { "post": { "operationId": "runs-sync-carmentara-shopify-app-intel", "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/carmentara~shopify-app-intel/run-sync": { "post": { "operationId": "run-sync-carmentara-shopify-app-intel", "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": "Mode", "enum": [ "apps", "category-rankings", "reviews", "keyword-ranks" ], "type": "string", "description": "Scrape app details, category/search rankings snapshot, keyword rank tracking, or app reviews.", "default": "apps" }, "keywords": { "title": "Search keywords", "type": "array", "description": "keyword-ranks mode: Shopify App Store search keywords to track (e.g. 'email marketing').", "items": { "type": "string" } }, "targetAppHandles": { "title": "Your / competitor apps to track", "type": "array", "description": "keyword-ranks mode (optional): app handles or app URLs. Adds one row per keyword x app with its organic position, ad placements and rank change.", "items": { "type": "string" } }, "onlyTargetApps": { "title": "Only output tracked apps", "type": "boolean", "description": "keyword-ranks mode: output only the rows for target apps (cheapest way to track your positions).", "default": false }, "maxResultsPerKeyword": { "title": "Results per keyword", "minimum": 1, "maximum": 240, "type": "integer", "description": "keyword-ranks mode: organic (non-ad) results to scan per keyword. 24 = first page.", "default": 24 }, "includeSponsored": { "title": "Include ads", "type": "boolean", "description": "keyword-ranks mode: also output sponsored (Ad) placements, flagged isSponsored.", "default": true }, "appUrls": { "title": "App URLs", "type": "array", "description": "Full app URLs (apps.shopify.com/...). Used in apps or reviews mode.", "items": { "type": "string" } }, "appHandles": { "title": "App handles", "type": "array", "description": "App handles like 'klaviyo-email-marketing'. Used in apps or reviews mode.", "items": { "type": "string" } }, "searchKeyword": { "title": "Search keyword", "type": "string", "description": "Keyword for search results (apps or category-rankings modes)." }, "category": { "title": "Category", "type": "string", "description": "Category slug from apps.shopify.com/categories/... (category-rankings or apps)." }, "onlyNew": { "title": "Only new (delta)", "type": "boolean", "description": "Use KV delta store to only return new reviews, flag pricing changes, and include rank changes.", "default": true }, "deltaStoreName": { "title": "Delta store name", "type": "string", "description": "Name of the key-value store for deltas (allowed chars: a-zA-Z0-9!-_.'()).", "default": "shopify-app-store-intel-delta" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 200, "type": "integer", "description": "Limit apps in apps mode or ranking items in category-rankings mode.", "default": 30 }, "maxReviewsPerApp": { "title": "Max reviews per app", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Reviews mode: maximum number of reviews to output per app.", "default": 100 }, "maxPpeChargeUSD": { "title": "Max PPE charge (USD)", "type": "number", "description": "Cap spend from Actor.charge PPE events. The actor stops when reached.", "default": 1 }, "useApifyProxy": { "title": "Use Apify proxy", "type": "boolean", "description": "Route requests through Apify Proxy (RESIDENTIAL group).", "default": false }, "proxyCountryCode": { "title": "Proxy country code", "type": "string", "description": "E.g. US, GB, DE. Applies only when proxy is enabled." }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of pages fetched in parallel.", "default": 2 }, "requestIntervalMs": { "title": "Polite request interval (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Delay before each request in milliseconds (polite crawling; doubled on retries in rankings/reviews modes).", "default": 1500 } } }, "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 } } } } } } } } } }