{ "openapi": "3.0.1", "info": { "title": "Shopify App Store Rank Tracker — Search & Category Ranks", "description": "Track where Shopify apps rank in App Store search and categories: rank, rank change since the last run, new entries, rating, review count, pricing, Built for Shopify and developer. Add your own or competitor apps to get their best rank per keyword. No login.", "version": "0.1", "x-build-id": "Cv5Kjk1pzWokh3yti" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/northbell~shopify-app-store-rank-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-northbell-shopify-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/northbell~shopify-app-store-rank-tracker/runs": { "post": { "operationId": "runs-sync-northbell-shopify-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/northbell~shopify-app-store-rank-tracker/run-sync": { "post": { "operationId": "run-sync-northbell-shopify-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": { "searches": { "title": "Search terms", "type": "array", "description": "What you would type in the Shopify App Store search box. Each search returns the apps in the store's order with their rank. Leave empty if you only want categories.", "items": { "type": "string" } }, "categories": { "title": "Categories (optional)", "type": "array", "description": "Category pages to rank, as a slug or URL, e.g. marketing-and-conversion-social-trust-product-reviews or https://apps.shopify.com/categories/marketing-and-conversion-customer-loyalty. Use the most specific category: parent categories have no ranked list.", "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Max apps per search or category", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many ranked apps to read for each search and category, in the store's order (about 20-24 per page). Ads are not counted.", "default": 24 }, "watch": { "title": "Watch (optional)", "type": "array", "description": "Your own or your competitors' apps, as an app handle or URL (judgeme or https://apps.shopify.com/judgeme). Each search and category then gets a summary row with their best rank and how it moved since the last run.", "items": { "type": "string" } }, "onlyWatched": { "title": "Only output watched apps", "type": "boolean", "description": "Return only the rows of watched apps, plus the summary row. You pay only for those rows.", "default": false }, "includeAds": { "title": "Also list ads", "type": "boolean", "description": "Add the paid \"Ad\" listings shown above the results as extra rows (isAd true, rank empty) to see who advertises on a keyword. Ads never count toward rank, and these rows are free.", "default": false }, "includeDeveloper": { "title": "Read developer names", "type": "boolean", "description": "Add the developer (company) name to each row. The store's result lists do not show it, so it is read from each app's page and remembered for 30 days. Turn off for the fastest run.", "default": true } } }, "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 } } } } } } } } } }