{ "openapi": "3.0.1", "info": { "title": "Agoda Reviews Scraper", "description": "Bulk Agoda guest reviews for one or more hotels: rating, text, date, traveler type, and a review-score breakdown. No login needed.", "version": "0.0", "x-build-id": "fRrBpPpWxCzjxenQH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/romy~agoda-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-romy-agoda-reviews-scraper", "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/romy~agoda-reviews-scraper/runs": { "post": { "operationId": "runs-sync-romy-agoda-reviews-scraper", "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/romy~agoda-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-romy-agoda-reviews-scraper", "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": [ "propertyIds" ], "properties": { "propertyIds": { "title": "Property ids", "type": "array", "description": "One or more Agoda property (hotel) ids.", "items": { "type": "string" } }, "maxReviewsPerProperty": { "title": "Max reviews per property", "minimum": 1, "type": "integer", "description": "Stop after this many reviews per property. Defaults to 200 as a spending guard; raise it to collect more (large hotels have thousands).", "default": 200 }, "sort": { "title": "Sort order", "enum": [ "recent", "highest", "lowest", "helpful" ], "type": "string", "description": "Order reviews are fetched (and paged) in.", "default": "recent" }, "traveler": { "title": "Traveler-group filter", "enum": [ "all", "business", "couple", "solo", "family_young_children", "family_teens", "group" ], "type": "string", "description": "Only reviews from this traveler-group demographic.", "default": "all" }, "languageIds": { "title": "Review-language ids", "type": "array", "description": "Filter to these review-language ids (from the review endpoint's own filtersAvailable.Language). Switches Agoda's API to \"filter mode\", which ignores the per-page size and returns a server-fixed ~50-70 items per page.", "items": { "type": "string" } }, "roomTypeIds": { "title": "Room-type ids", "type": "array", "description": "Filter to these room-type ids (matches the /rooms endpoint's roomTypeId). Also switches Agoda's API to \"filter mode\" (see languageIds).", "items": { "type": "string" } }, "provider": { "title": "Review provider", "enum": [ "agoda", "booking.com" ], "type": "string", "description": "Keep only this provider's reviews (client-side filter on Agoda's merged response). Leave empty for both." }, "includeReviewerName": { "title": "Include reviewer identity", "type": "boolean", "description": "Adds the reviewer's display name, uploaded photos, and the hotel's response text (which can name the guest) to each review. This is personal data; leave off unless you need it.", "default": false }, "includeReviewScores": { "title": "Include a review-score summary row per property", "type": "boolean", "description": "Adds one row per property with the combined review score, per-provider score, category grades by traveler group, and recommendation snippets.", "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }