{ "openapi": "3.0.1", "info": { "title": "Google Reviews Monitor", "description": "Monitor Google reviews for your business and your competitors. Pull every review with its rating, author and owner reply, filter to complaints only, and get just the new ones on every scheduled run.", "version": "0.1", "x-build-id": "jj3070x75gGsZTvek" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arched_friend~google-reviews-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arched_friend-google-reviews-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/arched_friend~google-reviews-monitor/runs": { "post": { "operationId": "runs-sync-arched_friend-google-reviews-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/arched_friend~google-reviews-monitor/run-sync": { "post": { "operationId": "run-sync-arched_friend-google-reviews-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", "properties": { "businesses": { "title": "Businesses to watch", "type": "array", "description": "Business names to look up, one per line. Add the town to avoid matching the wrong branch, for example Blacklock Manchester.", "items": { "type": "string" } }, "placeUrls": { "title": "Google Maps place URLs", "type": "array", "description": "Optional. Paste exact Google Maps place links when you want no ambiguity about which branch is checked.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxReviewsPerPlace": { "title": "Reviews per business", "minimum": 1, "type": "integer", "description": "How many reviews to load for each business.", "default": 100 }, "sortBy": { "title": "Sort order", "enum": [ "newest", "relevant", "highest", "lowest" ], "type": "string", "description": "Which reviews Google loads first.", "default": "newest" }, "onlyNewReviews": { "title": "Only reviews I have not seen", "type": "boolean", "description": "Remember review ids across runs and return only what appeared since last time. Turn this on for scheduled monitoring.", "default": false }, "minRating": { "title": "Minimum star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep only reviews rated at least this high.", "default": 1 }, "maxRating": { "title": "Maximum star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep only reviews rated at most this high. Set both to 2 to watch complaints only.", "default": 5 }, "searchQuery": { "title": "Keyword", "type": "string", "description": "Keep only reviews mentioning this word, for example parking, rude or wait." }, "since": { "title": "Only reviews after", "type": "string", "description": "A date such as 2026-08-01. Google gives approximate review dates, so this filter is approximate too." }, "language": { "title": "Language", "type": "string", "description": "Two letter language code for the Maps interface.", "default": "en" }, "countryCode": { "title": "Country bias", "type": "string", "description": "Two letter country code that biases the business lookup, for example us, gb, de.", "default": "" }, "maxConcurrency": { "title": "Parallel pages", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many businesses to load at once. Lower this if you see rate limiting.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Defaults to residential, which this Actor needs. Google serves the reviews pane to datacenter addresses inconsistently, so plain datacenter proxies return empty runs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }