{ "openapi": "3.0.1", "info": { "title": "Retail VoC Store Review Sweep", "description": "Sweeps Google Maps store reviews across many brand/location queries, normalizes and classifies each review (sentiment, topic, severity) with no LLM key required. Output rows carry the real review permalink.", "version": "0.1", "x-build-id": "LbSsZdVIgQhuDAj9Z" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/coppery_bulldozer~retail-voc-store-review-sweep/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-coppery_bulldozer-retail-voc-store-review-sweep", "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/coppery_bulldozer~retail-voc-store-review-sweep/runs": { "post": { "operationId": "runs-sync-coppery_bulldozer-retail-voc-store-review-sweep", "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/coppery_bulldozer~retail-voc-store-review-sweep/run-sync": { "post": { "operationId": "run-sync-coppery_bulldozer-retail-voc-store-review-sweep", "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": { "brand": { "title": "Brand", "type": "string", "description": "The brand to sweep, e.g. `Guardian`, `Sephora`, `Watsons`. The actor finds this brand's store branches on Google Maps (scoped to `country`) and pulls each branch's reviews. Leave empty to use the advanced multi-brand `brands` list below instead." }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code that anchors the map search, e.g. `vn` (Vietnam), `sg` (Singapore), `id` (Indonesia). Without it, Google Maps picks an arbitrary center and coverage suffers.", "default": "vn" }, "maxPlaces": { "title": "Max store branches per brand", "minimum": 1, "maximum": 200, "type": "integer", "description": "How many store branches to enumerate per brand. Higher = more branches covered and higher cost.", "default": 10 }, "maxReviewsPerPlace": { "title": "Max reviews per store", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many reviews to pull from each branch. Higher = more data and higher cost.", "default": 40 }, "brands": { "title": "Brands (advanced, multi-brand)", "type": "array", "description": "Advanced: compare several brands in one run (e.g. you vs competitors). One entry per brand: `{ \"brand\": \"Guardian\", \"searchTerms\": [\"Guardian\"], \"country\": \"vn\" }`. `searchTerms` and `country` are optional (default to the brand name and the top-level `country`). Ignored when a single `brand` is set above. Left empty, the run defaults to Guardian vs Hasaki vs Watsons." }, "language": { "title": "Reviews language", "type": "string", "description": "Language code passed to the Google Maps scraper.", "default": "vi" }, "classify": { "title": "Classify reviews", "type": "boolean", "description": "Run the built-in rule-based classifier (sentiment, topic, severity) on each review. No API key needed. Turn off for raw reviews only.", "default": true } } }, "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 } } } } } } } } } }