{ "openapi": "3.0.1", "info": { "title": "SEO Service Area Visibility Checker", "description": "Check a target domain's Google SERP visibility across multiple cities and keywords. Returns per-(keyword,city) rank and top competitors, plus a summary visibility score.", "version": "1.0", "x-build-id": "uzwORmCNv4SL3H8Bw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~seo-service-area-visibility/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-seo-service-area-visibility", "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/crawlerbros~seo-service-area-visibility/runs": { "post": { "operationId": "runs-sync-crawlerbros-seo-service-area-visibility", "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/crawlerbros~seo-service-area-visibility/run-sync": { "post": { "operationId": "run-sync-crawlerbros-seo-service-area-visibility", "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": [ "targetDomain", "keywords", "cities" ], "properties": { "targetDomain": { "title": "Target Domain", "type": "string", "description": "Your domain to track (e.g. 'example.com'). No protocol, no trailing slash." }, "keywords": { "title": "Keywords", "type": "array", "description": "List of service keywords to check (e.g. 'plumber', 'bakery').", "items": { "type": "string" } }, "cities": { "title": "Cities / Service Areas", "type": "array", "description": "List of city names. Each keyword is queried once per city with location context.", "items": { "type": "string" } }, "country": { "title": "Country (gl param)", "enum": [ "us", "gb", "de", "fr", "es", "it", "nl", "pl", "at", "ch", "be", "ie", "se", "no", "dk", "fi", "pt", "gr", "cz", "ru", "tr", "au", "nz", "ca", "jp", "kr", "cn", "in", "id", "ph", "th", "vn", "my", "sg", "br", "mx", "ar", "cl", "co", "pe", "ae", "sa", "za", "eg", "ng", "ke" ], "type": "string", "description": "Two-letter Google country code.", "default": "us" }, "language": { "title": "Language (hl param)", "enum": [ "en", "de", "fr", "es", "it", "nl", "pl", "pt", "sv", "no", "da", "fi", "cs", "ru", "tr", "ja", "ko", "zh", "hi", "id", "th", "vi", "ms", "ar", "he" ], "type": "string", "description": "Two-letter Google language code.", "default": "en" }, "maxResults": { "title": "Max Results per Query", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many organic results to parse per query (Google caps at 100).", "default": 10 }, "maxQueryRetries": { "title": "Max Query Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "How many times to retry a single (keyword, city) query on failure.", "default": 2 }, "retryBackoffMs": { "title": "Retry Backoff (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Wait time between retries in milliseconds.", "default": 2000 }, "includeCompetitors": { "title": "Include Competitors", "type": "boolean", "description": "Include top competitor domains in the summary row.", "default": true }, "perQuerySession": { "title": "Fresh Proxy Session Per Query", "type": "boolean", "description": "Rotate the Apify GOOGLE_SERP proxy session on every (keyword, city) to minimise soft-blocks. Default on.", "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 } } }, "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 } } } } } } } } } }