{ "openapi": "3.0.1", "info": { "title": "SEO Service Area Visibility Checker", "description": "Checks how visible a business is in Google across multiple service areas and generates an SEO visibility report.", "version": "0.1", "x-build-id": "qjSkVhopRiEZNqM7H" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solutionssmart~seo-service-area-visibility/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solutionssmart-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/solutionssmart~seo-service-area-visibility/runs": { "post": { "operationId": "runs-sync-solutionssmart-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/solutionssmart~seo-service-area-visibility/run-sync": { "post": { "operationId": "run-sync-solutionssmart-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", "pattern": "^(?!https?://)(?!www\\.$)[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$", "type": "string", "description": "The bare domain to check for in Google results, for example example.de." }, "keywords": { "title": "Keywords", "minItems": 1, "type": "array", "description": "Service keywords to search in each city.", "items": { "type": "string", "minLength": 1 }, "default": [ "Sanitär", "Heizung", "Installateur" ] }, "cities": { "title": "Cities", "minItems": 1, "type": "array", "description": "Cities or service areas where visibility should be checked.", "items": { "type": "string", "minLength": 1 }, "default": [ "Hameln", "Bad Münder", "Hannover", "Hildesheim" ] }, "country": { "title": "Country", "enum": [ "DE", "US", "GB", "FR", "ES", "IT", "NL", "PL", "AT", "CH" ], "type": "string", "description": "Choose the Google country code used in the search query.", "default": "DE" }, "language": { "title": "Language", "enum": [ "de", "en", "fr", "es", "it", "nl", "pl" ], "type": "string", "description": "Choose the Google interface language code used for the search results page.", "default": "de" }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of organic results to inspect per query.", "default": 10 }, "maxQueryRetries": { "title": "Max Query Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "How many times to retry a query after anti-bot pages or transient failures.", "default": 2 }, "retryBackoffMs": { "title": "Retry Backoff (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Base delay in milliseconds before retrying blocked or failed queries.", "default": 4000 }, "stickyProxySession": { "title": "Sticky Proxy Session", "type": "boolean", "description": "Keep the same proxy session for a full query and rotate only after harder blocks such as HTTP 429 responses.", "default": true }, "rotateProxySession": { "title": "Rotate Proxy Session", "type": "boolean", "description": "When enabled, retries can use a fresh proxy session instead of reusing the original one.", "default": true }, "warmupGoogleHome": { "title": "Warm Up Google Home", "type": "boolean", "description": "Open the Google homepage before the search request to establish a more natural browser session.", "default": false }, "warmupOnRetries": { "title": "Warm Up On Retries", "type": "boolean", "description": "Repeat the Google homepage warmup on retry attempts. Disable to reduce extra requests and proxy noise.", "default": false }, "disableWarmupAfterBlock": { "title": "Disable Warmup After Block", "type": "boolean", "description": "After the first anti-bot or CAPTCHA page in a run, stop using Google homepage warmup for later attempts.", "default": true }, "saveDebugArtifacts": { "title": "Save Debug Artifacts", "type": "boolean", "description": "Store screenshots and HTML diagnostics for blocked or unexpected pages.", "default": true }, "saveDebugArtifactsOnRetries": { "title": "Save Debug Artifacts On Retries", "type": "boolean", "description": "Keep saving screenshots and HTML diagnostics on retry attempts after the first blocked page.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional proxy settings for reducing Google anti-bot blocking.", "default": { "useApifyProxy": 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 } } } } } } } } } }