{ "openapi": "3.0.1", "info": { "title": "Yelp Scraper: Reputation Monitor", "description": "Monitor public Yelp businesses with URLs, or find them with one category and location query. Get structured profiles, review evidence, sentiment themes, attention signals, repeat-run changes, and competitor comparisons.", "version": "0.0", "x-build-id": "Lvg95xfJ0ElzxeZDh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~yelp-reputation-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-yelp-reputation-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/maximedupre~yelp-reputation-monitor/runs": { "post": { "operationId": "runs-sync-maximedupre-yelp-reputation-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/maximedupre~yelp-reputation-monitor/run-sync": { "post": { "operationId": "run-sync-maximedupre-yelp-reputation-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": [ "findBusinessesBy" ], "properties": { "findBusinessesBy": { "title": "Find businesses by", "enum": [ "businessUrls", "categoryLocation" ], "type": "string", "description": "Choose Business URLs for a supplied watchlist, or Category and location for one Yelp discovery query." }, "businessUrls": { "title": "Business URLs", "type": "array", "description": "Enter one or more public Yelp business page URLs to track. This field is required for this choice. If you add competitor URLs, the first URL is the anchor location.", "items": { "type": "object", "properties": { "url": { "title": "Yelp business URL", "type": "string", "description": "A public Yelp business page URL.", "pattern": "^https?://" } }, "required": [ "url" ] } }, "competitorUrls": { "title": "Competitor URLs", "type": "array", "description": "Optionally add public Yelp business page URLs to compare with the first Business URL. These locations are also tracked when supplied.", "items": { "type": "object", "properties": { "url": { "title": "Yelp competitor URL", "type": "string", "description": "A public Yelp business page URL for the comparison set.", "pattern": "^https?://" } }, "required": [ "url" ] } }, "category": { "title": "Business category", "minLength": 1, "type": "string", "description": "Enter one category for the Yelp search, such as restaurants or dentists. This field is required for this choice." }, "location": { "title": "Location", "minLength": 1, "type": "string", "description": "Enter one city, area, or address for the Yelp search. This field is required for this choice." }, "includeProfileEnrichment": { "title": "Include profile enrichment", "type": "boolean", "description": "Add public contact information, hours, open state, and other business attributes when Yelp provides them.", "default": false }, "includeReviewEvidence": { "title": "Include review evidence", "type": "boolean", "description": "Return public review records with full text, star rating, date, language, and available reviewer context.", "default": true }, "maxLocations": { "title": "Maximum locations", "minimum": 1, "type": "integer", "description": "Stop after this many business locations. Leave it empty to process every available location until the source is exhausted." } } }, "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 } } } } } } } } } }