{ "openapi": "3.0.1", "info": { "title": "WIE — Web Design Opportunity Finder", "description": "Find local businesses with evidence-backed website opportunities. WIE discovers businesses or analyzes your list with bounded deterministic checks. WIE bills only conclusive evaluations; inconclusive results are not billed", "version": "0.0", "x-build-id": "sODgDgr0qYVBGaTvg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/overbifrost~wie-web-design-opportunity-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-overbifrost-wie-web-design-opportunity-finder", "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/overbifrost~wie-web-design-opportunity-finder/runs": { "post": { "operationId": "runs-sync-overbifrost-wie-web-design-opportunity-finder", "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/overbifrost~wie-web-design-opportunity-finder/run-sync": { "post": { "operationId": "run-sync-overbifrost-wie-web-design-opportunity-finder", "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": "I want to", "enum": [ "discover", "direct" ], "type": "string", "description": "Choose whether WIE should discover local businesses automatically or analyze businesses you provide.", "default": "discover" }, "searchTerm": { "title": "Business type", "type": "string", "description": "Business type or search term, for example plumber, dentist, electrician, or accountant." }, "location": { "title": "Location", "type": "string", "description": "City, region, or area to search." }, "maxPlaces": { "title": "Number of businesses", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum number of businesses to discover and evaluate (1-200). Runtime default: 50." }, "targets": { "title": "Businesses to analyze", "maxItems": 500, "type": "array", "description": "Add one row per business. Only Website is required. Maximum 500 entries.", "items": { "type": "object", "properties": { "website": { "title": "Website", "type": "string", "editor": "textfield", "minLength": 1, "description": "The business website address, for example https://example.com." }, "businessName": { "title": "Business name", "type": "string", "editor": "textfield", "description": "Optional business name shown in the results." }, "externalId": { "title": "External ID", "type": "string", "editor": "textfield", "description": "Optional identifier supplied by you and carried through to the results." } }, "required": [ "website" ], "additionalProperties": false } }, "sourceDatasetId": { "title": "Source dataset", "type": "string", "description": "Select a dataset whose rows contain 'website'; optional 'businessName' and 'externalId' are carried through." }, "maxConcurrentlyAnalyzedBusinesses": { "title": "Website analysis concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of business websites checked in parallel (1-20)." }, "discoveryLanguage": { "title": "Maps language / locale", "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "type": "string", "description": "Optional Maps locale such as en, en-GB, nb-NO, de-DE, or fr-FR. Runtime default: en." }, "discoveryProxyStrategy": { "title": "Maps proxy strategy", "enum": [ "AUTO", "NONE", "APIFY_DATACENTER", "APIFY_RESIDENTIAL" ], "type": "string", "description": "AUTO uses the normal configured Apify proxy route and never silently selects residential traffic. Residential is explicit." } } }, "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 } } } } } } } } } }