{ "openapi": "3.0.1", "info": { "title": "Google Business Profile Audit: Competitors & Fixes", "description": "Audit a Google Maps business against nearby competitors. Get an evidence-based score, review insights, category gaps, website NAP checks, ranked fixes, local rankings and an agency-branded HTML report. Track changes with a named store.", "version": "0.1", "x-build-id": "FkjWeEUg1rCCbyfd5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zaiq~google-business-profile-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zaiq-google-business-profile-audit", "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/zaiq~google-business-profile-audit/runs": { "post": { "operationId": "runs-sync-zaiq-google-business-profile-audit", "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/zaiq~google-business-profile-audit/run-sync": { "post": { "operationId": "run-sync-zaiq-google-business-profile-audit", "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": { "businesses": { "title": "Businesses", "type": "array", "description": "Maps URLs, place IDs, or exact business names with cities. Up to 200; ambiguous names produce a free note. Empty input uses the sample profile.", "items": { "type": "string" }, "default": [] }, "primaryKeyword": { "title": "Primary keyword", "type": "string", "description": "The service customers search for. Empty uses the displayed primary category.", "default": "" }, "competitors": { "title": "Competitors (optional)", "type": "array", "description": "Exact Maps URLs, IDs, or names with cities. Empty discovers nearby competitors; at most 10.", "items": { "type": "string" }, "default": [] }, "competitorLimit": { "title": "Competitors to compare", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of automatically discovered peers to inspect. Competitor lookups are included.", "default": 5 }, "rankCheck": { "title": "Rank snapshot", "enum": [ "off", "point", "grid" ], "type": "string", "description": "Off still permits a local search for competitor discovery. Point reads the centre. Grid adds 8 points and a separate fee only for a complete grid.", "default": "point" }, "rankCenter": { "title": "Rank centre (optional)", "type": "string", "description": "Latitude,longitude of the customer location. Empty uses the public profile pin; service-area pins can be approximate.", "default": "" }, "gridSpacingKm": { "title": "Grid spacing (km)", "minimum": 0.1, "maximum": 10, "type": "number", "description": "Distance between neighbouring grid points. A 3 × 3 grid covers twice this distance from edge to edge.", "default": 1 }, "reviewsToRead": { "title": "Reviews to read", "minimum": 0, "maximum": 100, "type": "integer", "description": "Requested maximum. Signed-out access often exposes only a most-relevant preview. The Actor reports sample coverage and never treats a partial sample as complete 30/90-day totals.", "default": 100 }, "checkWebsite": { "title": "Check website", "type": "boolean", "description": "Read the linked public website for name, address, phone and LocalBusiness schema. Uses static HTML and respects robots rules.", "default": true }, "websitePages": { "title": "Website pages per business", "minimum": 1, "maximum": 5, "type": "integer", "description": "Bounded homepage and contact/about/location crawl. No browser; at most 15 requests including redirects and robots per site.", "default": 3 }, "country": { "title": "Lookup country", "type": "string", "description": "Two-letter country for the initial lookup. Local searches then use the country shown on the resolved business.", "default": "us" }, "language": { "title": "Profile language", "type": "string", "description": "Language code for public Maps responses. Theme rules support English review text only.", "default": "en" }, "agencyName": { "title": "Agency name", "type": "string", "description": "Agency name printed in the standalone HTML report.", "default": "" }, "agencyLogoUrl": { "title": "Agency logo URL", "type": "string", "description": "Optional direct public PNG, JPEG, GIF or WebP under 512 KB. Embedded into the report; SVG and redirects are not used.", "default": "" }, "comparisonStore": { "title": "Comparison store", "type": "string", "description": "Optional named key-value store for repeat audits. Use the same name monthly. Keeps up to 2,000 latest business snapshots. Avoid concurrent runs writing the same store.", "default": "" } } }, "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 } } } } } } } } } }