{ "openapi": "3.0.1", "info": { "title": "Google Maps Reviews Scraper & Analyzer", "description": "Turn hundreds of Google Maps reviews into a clear report: satisfaction score, top praises, top complaints, rating trend, and highlight quotes.", "version": "0.1", "x-build-id": "66N1HBnZNNZCsWvLT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/salem5077~google-reviews-analyzer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-salem5077-google-reviews-analyzer", "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/salem5077~google-reviews-analyzer/runs": { "post": { "operationId": "runs-sync-salem5077-google-reviews-analyzer", "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/salem5077~google-reviews-analyzer/run-sync": { "post": { "operationId": "run-sync-salem5077-google-reviews-analyzer", "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": { "placeUrls": { "title": "Google Maps place URL(s)", "type": "array", "description": "Paste one or more Google Maps URLs of the businesses you want to analyze. Either fill this OR use the Search term below.", "items": { "type": "string" } }, "searchTerm": { "title": "Search term (optional)", "type": "string", "description": "Instead of URLs, search Google Maps by name, e.g. 'Starbucks' or 'pizza restaurant'. Use together with Location." }, "location": { "title": "Location (optional)", "type": "string", "description": "City + Country for the search term, e.g. 'Los Angeles, USA'." }, "maxPlaces": { "title": "Max places to analyze", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many businesses to analyze per search term.", "default": 1 }, "maxReviews": { "title": "Reviews to analyze per place", "minimum": 10, "maximum": 5000, "type": "integer", "description": "How many reviews to pull and analyze for each business. More reviews = deeper analysis but higher cost.", "default": 50 }, "reviewsSort": { "title": "Reviews order", "enum": [ "newest", "mostRelevant", "highestRanking", "lowestRanking" ], "type": "string", "description": "Which reviews to prioritize when pulling them.", "default": "newest" }, "reviewsSince": { "title": "Only analyze reviews since (optional)", "type": "string", "description": "Focus the analysis on recent feedback. Use an absolute date (e.g. 2025-01-01) or a relative range (e.g. '3 months', '1 year', '30 days'). Leave empty to analyze all reviews." }, "reviewsKeyword": { "title": "Only analyze reviews containing keyword (optional)", "type": "string", "description": "Analyze only reviews that mention a specific word or phrase (e.g. 'delivery', 'parking', 'staff'). Great for digging into one topic. Leave empty to analyze all reviews." }, "compareMode": { "title": "Competitor comparison", "type": "boolean", "description": "When you analyze 2 or more businesses, also produce a side-by-side comparison report (ranking, who wins each aspect, shared complaints, and a verdict). Add your business + competitors via the URLs or by raising 'Max places'.", "default": true }, "generatePdf": { "title": "Generate PDF report", "type": "boolean", "description": "Also create a polished, printable PDF report for each business (with charts, aspect ratings, and recommendations). A download link is added to each result as 'pdfReportUrl'.", "default": true }, "language": { "title": "Language", "type": "string", "description": "Language for the scraped data (e.g. 'en' for English, 'es' for Spanish).", "default": "en" } } }, "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 } } } } } } } } } }