{ "openapi": "3.0.1", "info": { "title": "Yelp Review + Owner-Response Incident Monitor", "description": "Monitor Yelp reviews and owner responses. Detect new negative reviews, unanswered complaints, service, price, quality and wait-time incidents, response delays, rating changes, and complaint spikes.", "version": "1.0", "x-build-id": "zhRbCbjCKkntyhVc2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/herazur~yelp-review-owner-response-incident-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-herazur-yelp-review-owner-response-incident-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/herazur~yelp-review-owner-response-incident-monitor/runs": { "post": { "operationId": "runs-sync-herazur-yelp-review-owner-response-incident-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/herazur~yelp-review-owner-response-incident-monitor/run-sync": { "post": { "operationId": "run-sync-herazur-yelp-review-owner-response-incident-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": [ "businesses" ], "properties": { "businesses": { "title": "Businesses", "minItems": 1, "maxItems": 500, "type": "array", "description": "Public Yelp business URLs to monitor. Add an optional display name. Advanced users may provide the public page's Yelp business ID to skip URL resolution.", "items": { "type": "object", "properties": { "name": { "type": "string", "title": "Custom business name", "description": "Optional label used in output instead of Yelp's public business name." }, "url": { "type": "string", "title": "Yelp business URL", "description": "Public URL containing /biz/." }, "encBizId": { "type": "string", "title": "Yelp business ID (advanced)", "description": "Optional public Yelp business ID that skips the URL-resolution request." } }, "required": [ "url" ] }, "default": [ { "name": "The French Laundry", "url": "https://www.yelp.com/biz/the-french-laundry-yountville-7", "encBizId": "T20VEwi7AzKbY2TuVEt_ig" } ] }, "maxReviewsPerBusiness": { "title": "Maximum reviews per business", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of recent reviews inspected during each run.", "default": 100 }, "onlyChanges": { "title": "Only changes", "type": "boolean", "description": "Return only newly discovered reviews and reputation incidents since the previous successful run. The first run establishes a quiet baseline.", "default": true }, "maximumIncidentRating": { "title": "Negative review threshold", "minimum": 1, "maximum": 5, "type": "integer", "description": "Reviews at or below this rating are treated as negative incidents.", "default": 2 }, "unansweredAfterHours": { "title": "Owner response SLA", "minimum": 1, "maximum": 8760, "type": "integer", "description": "How long a negative review may remain unanswered before one incident is generated.", "default": 48 }, "detectSignals": { "title": "Detect complaint signals", "type": "boolean", "description": "Detect service, wait-time, price, quality, cleanliness, and order-related complaints with deterministic phrase matching.", "default": true }, "includeReviewText": { "title": "Include review text", "type": "boolean", "description": "Include publicly visible review and owner-response text in output events.", "default": true }, "monitorOwnerResponses": { "title": "Monitor owner responses", "type": "boolean", "description": "Detect newly added public business-owner replies and response-SLA incidents.", "default": true }, "stateStoreName": { "title": "Monitoring state store", "pattern": "^[a-z0-9][a-z0-9-]{1,62}[a-z0-9]$", "type": "string", "description": "Named Key-Value Store used across scheduled runs. Use a different name to isolate separate monitoring tasks.", "default": "yelp-reputation-monitor-state" }, "dateCutoff": { "title": "Review date cutoff", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional earliest review date to inspect, in YYYY-MM-DD format." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Yelp commonly challenges datacenter traffic. Apify Residential proxy with a US country is recommended for reliable URL resolution.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }