{ "openapi": "3.0.1", "info": { "title": "Maps Business Coverage Gap Finder", "description": "Identify category-versus-area gaps in owned place datasets, with sample limitations made explicit. For Location intelligence and market research teams. Check the live Pricing tab and input limits.", "version": "0.1", "x-build-id": "15UTdfH3gDQbRgcBR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/practical_ai_lab_jp~pal-maps-business-coverage-gaps/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-practical_ai_lab_jp-pal-maps-business-coverage-gaps", "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/practical_ai_lab_jp~pal-maps-business-coverage-gaps/runs": { "post": { "operationId": "runs-sync-practical_ai_lab_jp-pal-maps-business-coverage-gaps", "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/practical_ai_lab_jp~pal-maps-business-coverage-gaps/run-sync": { "post": { "operationId": "run-sync-practical_ai_lab_jp-pal-maps-business-coverage-gaps", "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": { "listings": { "title": "Listings (inline JSON)", "type": "array", "description": "Business listing records. Each needs a category and a postal code (or city when regionMode is 'city'). Optional: placeId or name (for de-duplication), rating, reviewsCount, source (label for comparing datasets). Contact fields are ignored." }, "datasetIds": { "title": "Existing dataset IDs", "type": "array", "description": "Optional IDs of Apify datasets in your account that already contain business listings. Each dataset is labelled dataset_1, dataset_2, ... in the comparison. Maximum 20.", "items": { "type": "string" } }, "regionMode": { "title": "Area definition", "enum": [ "postal_prefix", "city" ], "type": "string", "description": "Group listings by the first characters of the postal code, or by city name.", "default": "postal_prefix" }, "postalPrefixLength": { "title": "Postal prefix length", "minimum": 1, "maximum": 6, "type": "integer", "description": "Number of leading postal code characters that define an area (letters and digits only).", "default": 3 }, "regionPopulation": { "title": "Area population (optional)", "type": "object", "description": "Optional map of area key to population or another demand proxy, for example {\"100\": 52000}. Enables a per-capita baseline and also detects areas with zero listings." }, "categoryAliases": { "title": "Category aliases (optional)", "type": "object", "description": "Optional map that merges similar category names, for example {\"coffee shop\": \"cafe\"}." }, "minCategoryListings": { "title": "Minimum listings per category", "minimum": 1, "type": "integer", "description": "Categories with fewer listings in total are not analysed.", "default": 5 }, "minExpectedListings": { "title": "Minimum expected listings", "minimum": 0.1, "type": "number", "description": "Ignore cells where the baseline expects fewer listings than this. Higher values reduce noise.", "default": 3 }, "maxObservedToExpectedRatio": { "title": "Maximum observed / expected ratio", "minimum": 0, "maximum": 1, "type": "number", "description": "A cell is flagged only if observed listings are at or below this share of the expected count.", "default": 0.5 }, "minDeficit": { "title": "Minimum deficit (expected minus observed)", "minimum": 0.1, "type": "number", "description": "Minimum number of missing listings for a cell to be flagged.", "default": 2 }, "maxListings": { "title": "Maximum listings to read", "minimum": 1, "maximum": 500000, "type": "integer", "description": "Safety limit on accepted listings.", "default": 50000 }, "maxRegions": { "title": "Maximum areas", "minimum": 2, "maximum": 2000, "type": "integer", "description": "Keep only the largest areas (by listings, or by population if supplied).", "default": 500 }, "maxCategories": { "title": "Maximum categories", "minimum": 2, "maximum": 1000, "type": "integer", "description": "Keep only the most frequent categories.", "default": 200 }, "maxResults": { "title": "Maximum result rows", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Number of top-ranked underserved cells to return.", "default": 200 } } }, "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 } } } } } } } } } }