{ "openapi": "3.0.1", "info": { "title": "Agoda Reviews Extractor", "description": "Agoda reviews scraper that pulls hotel guest reviews, ratings, hotel replies, room types, and reviewer countries from any Agoda hotel URL, so SEO teams and hotels can track reputation and check competitors without copying reviews by hand.", "version": "0.0", "x-build-id": "drfyK0jPg6wQ91nW7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kawsar~agoda-reviews-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kawsar-agoda-reviews-extractor", "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/kawsar~agoda-reviews-extractor/runs": { "post": { "operationId": "runs-sync-kawsar-agoda-reviews-extractor", "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/kawsar~agoda-reviews-extractor/run-sync": { "post": { "operationId": "run-sync-kawsar-agoda-reviews-extractor", "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": { "startUrls": { "title": "Agoda hotel URLs", "type": "array", "description": "One or more Agoda hotel page URLs to scrape reviews from. Paste the full hotel page URL (for example the page you land on after searching a hotel). The actor reads the hotel ID from each page automatically. Leave empty only if you supply a Hotel ID below.", "items": { "type": "string" } }, "hotelId": { "title": "Hotel ID (optional)", "type": "integer", "description": "Agoda numeric hotel ID. Use this only if you already know the ID and want to skip URLs. If both URLs and a Hotel ID are given, the URLs are used and this is ignored." }, "maxReviews": { "title": "Max reviews per hotel", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of reviews to collect per hotel. Keeps runs fast and predictable. Set higher to pull more, or lower for a quick sample.", "default": 100 }, "sortBy": { "title": "Sort reviews by", "enum": [ "7", "1", "2", "3" ], "type": "string", "description": "Order in which reviews are pulled from Agoda.", "default": "7" }, "language": { "title": "Review language", "enum": [ "en-gb", "en-us", "th-th", "zh-cn", "ja-jp", "ko-kr" ], "type": "string", "description": "Language for review content and Agoda's own text fields (rating labels, dates). Reviews written in other languages still come through, along with their machine translation into the selected language.", "default": "en-gb" }, "hotelProviderId": { "title": "Hotel provider ID", "type": "integer", "description": "Advanced. Primary review provider ID. Leave at 332 (Agoda) unless you know you need a different source.", "default": 332 }, "reviewProviderIds": { "title": "Review provider IDs", "type": "array", "description": "Advanced. List of review source IDs to include. The default set covers Agoda plus partner sources, which returns the widest pool of reviews.", "default": [ 332, 3038, 27901, 28999, 29100, 27999, 27980, 27989, 29014 ] }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Advanced. How long to wait for each Agoda request before giving up.", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to use for requests. Helps avoid IP blocking and rate limits. Datacenter proxies are fastest; Residential proxies are harder to detect." } } }, "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 } } } } } } } } } }