{ "openapi": "3.0.1", "info": { "title": "Apify Store Opportunity Radar", "description": "Analyze public Apify Store metadata through the official API and rank Actor opportunities with evidence, pricing, quality, and change history.", "version": "0.1", "x-build-id": "u1M8dbPqOIZhHt64d" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/invaluable_rondeau~apify-store-opportunity-radar/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-invaluable_rondeau-apify-store-opportunity-radar", "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/invaluable_rondeau~apify-store-opportunity-radar/runs": { "post": { "operationId": "runs-sync-invaluable_rondeau-apify-store-opportunity-radar", "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/invaluable_rondeau~apify-store-opportunity-radar/run-sync": { "post": { "operationId": "run-sync-invaluable_rondeau-apify-store-opportunity-radar", "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": { "mode": { "title": "Mode", "enum": [ "keyword-search", "actor-competitor", "category-opportunity", "store-change-monitor" ], "type": "string", "description": "Choose a keyword, actor competitor, category, or change-monitor analysis.", "default": "keyword-search" }, "keywords": { "title": "Keywords", "maxItems": 20, "type": "array", "description": "Up to 20 Store search terms.", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "default": [ "email verifier" ] }, "actorUrls": { "title": "Actor URLs or slugs", "maxItems": 50, "type": "array", "description": "Public Actor URL, username/name slug, Actor ID, or name. Up to 50.", "items": { "type": "string", "minLength": 1, "maxLength": 300 }, "default": [] }, "categories": { "title": "Categories", "maxItems": 20, "type": "array", "description": "Optional official Store category filters.", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "default": [] }, "maxResults": { "title": "Maximum actors", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of unique public Actors to return, capped at 1,000.", "default": 100 }, "includeDescriptions": { "title": "Include descriptions", "type": "boolean", "description": "Keep the public description in each record.", "default": true }, "includeReadmeAnalysis": { "title": "Analyze public README signals", "type": "boolean", "description": "Fetch public Actor details and derive README/schema signals without storing README text.", "default": true }, "includePricing": { "title": "Include pricing", "type": "boolean", "description": "Include public pricing model and PPE event prices when available.", "default": true }, "includeUserMetrics": { "title": "Include public usage metrics", "type": "boolean", "description": "Include public user, run, rating, and review metrics when available.", "default": true }, "includeHistoricalComparison": { "title": "Compare history", "type": "boolean", "description": "Compare with the prior state in the scoped Key-Value Store when available.", "default": true }, "previousDatasetId": { "title": "Previous dataset ID", "type": "string", "description": "Optional prior Dataset ID used as a read-only history fallback. Leave blank when unused.", "default": "" }, "opportunityScoreEnabled": { "title": "Calculate opportunity score", "type": "boolean", "description": "Calculate the bounded relative opportunity score and evidence confidence.", "default": true }, "soloBuilderWinScoreEnabled": { "title": "Calculate Solo Builder Win Score", "type": "boolean", "description": "Rank market headroom for a new solo builder while retaining the legacy demand opportunity score.", "default": true }, "minUsers": { "title": "Minimum total users", "minimum": 0, "type": "integer", "description": "Exclude actors below this public total-user threshold.", "default": 0 }, "minMonthlyUsers": { "title": "Minimum 30-day active users", "minimum": 0, "type": "integer", "description": "Exclude actors below this public 30-day-user threshold.", "default": 0 }, "maxCompetitors": { "title": "Maximum competitors", "minimum": 1, "maximum": 200, "type": "integer", "description": "Limit the number of competitor candidates used in the comparison summary.", "default": 50 }, "sortBy": { "title": "Store sort", "enum": [ "relevance", "popularity", "newest", "lastUpdate" ], "type": "string", "description": "Official Store API ordering for each search request.", "default": "relevance" }, "language": { "title": "Language hint", "type": "string", "description": "Optional language hint retained for future filtering; no undocumented API filter is used. Leave blank when unused.", "default": "" }, "exportFormat": { "title": "Export format", "enum": [ "json", "csv" ], "type": "string", "description": "Output preference retained for compatibility; Dataset records remain JSON objects.", "default": "json" }, "dryRun": { "title": "Dry run", "type": "boolean", "description": "Use a local fixture and do not call the external Store API.", "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 } } } } } } } } } }