{ "openapi": "3.0.1", "info": { "title": "Traveloka Review & Sentiment Extractor", "description": "Download Traveloka reviews in bulk from a hotel or Xperience URL: review text (original and translated), score, date, reviewer, photos, and aspect sentiment tags with counts. Ready for NLP. HTTP-only, no browser.", "version": "0.0", "x-build-id": "z3aVY123DKr7G7t3e" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fanndev~traveloka-review-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fanndev-traveloka-review-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/fanndev~traveloka-review-extractor/runs": { "post": { "operationId": "runs-sync-fanndev-traveloka-review-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/fanndev~traveloka-review-extractor/run-sync": { "post": { "operationId": "run-sync-fanndev-traveloka-review-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": "Property or activity URLs", "type": "array", "description": "Traveloka hotel, Xperience activity, bus, airport-transfer or car-rental page URLs. The product family is detected from the URL path, so you can mix them freely.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "objectIds": { "title": "Object IDs", "type": "array", "description": "Bare numeric Traveloka object IDs. These use the Product type setting below, since there is no URL to infer it from.", "items": { "type": "string" } }, "productType": { "title": "Product type", "enum": [ "hotel", "experience", "experience-attraction", "experience-tour", "experience-spa", "experience-event", "bus", "airport-transfer", "car-rental" ], "type": "string", "description": "Which Traveloka product the IDs belong to. Only used for bare Object IDs and for URLs whose path cannot be classified.", "default": "hotel" }, "maxReviewsPerObject": { "title": "Max reviews per object", "minimum": 1, "maximum": 10000, "type": "integer", "description": "How many reviews to download for each property or activity. Reviews arrive in pages, so this is also the stopping point for pagination.", "default": 200 }, "sortBy": { "title": "Sort order", "enum": [ "SORT_CREATED_DESCENDING", "SORT_HELPFUL_DESCENDING", "SORT_RATING_DESCENDING", "SORT_RATING_ASCENDING" ], "type": "string", "description": "Order Traveloka returns reviews in. Newest first is best for monitoring; lowest rating first is best for a complaint audit.", "default": "SORT_CREATED_DESCENDING" }, "ratingFilter": { "title": "Rating filter", "enum": [ "RATING_VALUE_ALL", "RATING_VALUE_EXCEPTIONAL", "RATING_VALUE_VERY_GOOD", "RATING_VALUE_PLEASANT" ], "type": "string", "description": "Keep only reviews in a rating band. Traveloka exposes bands, not exact score cut-offs.", "default": "RATING_VALUE_ALL" }, "formatFilter": { "title": "Format filter", "enum": [ "FORMAT_VALUE_ALL", "FORMAT_VALUE_TEXT", "FORMAT_VALUE_MEDIA", "FORMAT_VALUE_TEXT_MEDIA" ], "type": "string", "description": "Keep only reviews that have text, media, or both. Useful when you need photos, or when you want to drop score-only ratings before running NLP.", "default": "FORMAT_VALUE_ALL" }, "ratingTagIds": { "title": "Aspect tag filter", "type": "array", "description": "Keep only reviews carrying these aspect tags, for example GOOD_STAFF_FRIENDLINESS or BAD_CLEANLINESS. Run once without this to see which tags an object has, listed in the summary record under ratingTags.", "items": { "type": "string" } }, "includeSummaryRecord": { "title": "Include a summary record per object", "type": "boolean", "description": "Emit one OBJECT_SUMMARY row per property or activity holding the overall rating, total review count and aspect tags, alongside the individual reviews.", "default": true }, "includeRatingTags": { "title": "Include aspect sentiment tags", "type": "boolean", "description": "Collect the aspect tag aggregate (cleanliness, staff, location and so on) with counts, split into positive and negative tag IDs.", "default": true }, "pageSize": { "title": "Reviews per request", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many reviews to ask for per API call. Twenty matches what Traveloka's own web client asks for.", "default": 20 }, "locale": { "title": "Locale", "enum": [ "en-id", "id-id", "en-sg", "en-my", "th-th", "vi-vn" ], "type": "string", "description": "Traveloka locale. This affects the language of aspect tag labels and rating labels, and which translation of a review text you receive.", "default": "en-id" }, "currency": { "title": "Currency", "enum": [ "IDR", "USD", "SGD", "MYR", "THB", "VND" ], "type": "string", "description": "Currency context for the session. Reviews carry no prices, so this rarely matters.", "default": "IDR" }, "requestDelaySeconds": { "title": "Delay between requests", "type": "string", "description": "Seconds to pause between API calls. Raise it if you see repeated 429 or 5xx responses on large pulls.", "default": "0.4" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy settings. The review API answers datacenter IPs normally, so the default is fine.", "default": { "useApifyProxy": 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 } } } } } } } } } }