{ "openapi": "3.0.1", "info": { "title": "Google Maps Listing Monitor - Hours, Phone & Address Changes", "description": "Catch the day a Google Maps business listing changes: address, phone, website, name, category, hours or permanently closed. Built for local SEO agencies and multi-location brands; review-count churn is ignored so alerts stay meaningful. Needs a Maps data source you supply.", "version": "1.1", "x-build-id": "xcpsPWD7h320dBxyD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/that_red_bird~maps-listing-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-that_red_bird-maps-listing-monitor", "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/that_red_bird~maps-listing-monitor/runs": { "post": { "operationId": "runs-sync-that_red_bird-maps-listing-monitor", "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/that_red_bird~maps-listing-monitor/run-sync": { "post": { "operationId": "run-sync-that_red_bird-maps-listing-monitor", "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": [ "places" ], "properties": { "places": { "title": "Places to watch", "type": "array", "description": "Listings to watch: Google Maps URLs (full or maps.app.goo.gl short links), place IDs (ChIJ...), or plain search text such as \"Starbucks 1 Times Sq New York\". Objects allowed: {\"placeUrl\":\"https://...\",\"label\":\"branch-01\"}. Up to a few hundred per run.", "default": [ "https://www.google.com/maps/place/?q=place_id:ChIJN1t_tDeuEmsRUsoyG83frY4" ] }, "provider": { "title": "Data source", "enum": [ "apify", "places" ], "type": "string", "description": "apify reads the listings with a Maps scraper Actor, all places in ONE run billed to your own Apify account (about $0.004 per place). places calls Google's official Places API (New) with your own key (a Google Cloud project with billing).", "default": "apify" }, "mapsActorId": { "title": "Maps Actor ID", "type": "string", "description": "Which Maps scraper Actor to run. Only used by the Apify Maps Actor data source. It must accept startUrls and searchStringsArray like compass/crawler-google-places.", "default": "compass/crawler-google-places" }, "googleApiKey": { "title": "Google Places API key", "type": "string", "description": "Required only for the Google Places API data source. Enable \"Places API (New)\" for the key. Stored encrypted." }, "language": { "title": "Language", "type": "string", "description": "Language code used when reading the listing, e.g. en, de, fr. Keep it the same between runs, a different language reads as changed names and categories.", "default": "en" }, "watchFields": { "title": "Fields to watch", "type": "array", "description": "Only these fields count as a change. Leave empty to watch them all except rating/reviews. Options: title, address, phone, website, categoryName, categories, openingHours, permanentlyClosed, temporarilyClosed, location, plusCode, claimThisBusiness, description, totalScore, reviewsCount (rating and review count also need \"Ignore rating and review count\" turned off).", "default": [], "items": { "type": "string" } }, "criticalFields": { "title": "Critical fields", "type": "array", "description": "Changes to these fields are flagged critical: the ones that break citations and cost rankings.", "default": [ "address", "phone", "website", "title", "permanentlyClosed", "temporarilyClosed" ], "items": { "type": "string" } }, "ignoreReviewCount": { "title": "Ignore rating and review count", "type": "boolean", "description": "On (recommended): rating and review count are shown in every row but never trigger a change. Off: a rating change, or a review-count change of at least the amount below, counts as a change.", "default": true }, "minReviewCountChange": { "title": "Review count change that counts", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Only used when \"Ignore rating and review count\" is off: the review count must move by at least this many to be reported.", "default": 5 }, "onlyChanges": { "title": "Only output changes", "type": "boolean", "description": "Push only listings that changed (plus repeatedly failing ones). Recommended when managing many locations.", "default": false }, "alertOnErrorAfter": { "title": "Report a broken listing after N failures", "minimum": 0, "maximum": 50, "type": "integer", "description": "Flag a place (brokenTarget) after it fails to load this many runs in a row, often because the listing was removed or merged. 0 disables it.", "default": 3 }, "resetBaseline": { "title": "Reset baseline", "type": "boolean", "description": "Forget stored listing data and start fresh.", "default": false }, "maxItems": { "title": "Max output rows", "minimum": 0, "type": "integer", "description": "Hard cap on dataset rows per run. 0 = no cap.", "default": 0 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many listings to fetch in parallel (Google Places API source only; the Maps Actor source runs all places in one batch).", "default": 3 }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "POSTed when a listing changes: JSON with a Slack/Discord-compatible text, plus the full change list. Leave empty for none.", "default": "" }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Named key-value store holding the last seen data per listing. Use a different name per client or project to keep their baselines apart.", "default": "maps-listing-monitor-state" } } }, "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 } } } } } } } } } }