{ "openapi": "3.0.1", "info": { "title": "Headout Reviews Scraper - Tours & Attractions", "description": "Scrape public Headout reviews for tours, attractions, tickets, museums, cruises, and experiences. Get ratings, original and translated text, reviewer details, countries, booking and tour IDs, traveler personas, photos, timestamps, and optional aggregate scores over a fast HTTP API.", "version": "1.0", "x-build-id": "5ej8ZTyH38fNSUAyg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thirdwatch~headout-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thirdwatch-headout-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/thirdwatch~headout-reviews-scraper/runs": { "post": { "operationId": "runs-sync-thirdwatch-headout-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/thirdwatch~headout-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-thirdwatch-headout-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", "properties": { "startUrls": { "title": "Headout activity URLs", "type": "array", "description": "Headout pages for tours, attractions, museums, tickets, cruises, or other experiences.", "default": [], "items": { "type": "string" } }, "tourGroupIds": { "title": "Headout tour-group IDs", "type": "array", "description": "Optional numeric IDs from the e-12345 suffix in Headout activity URLs.", "default": [], "items": { "type": "string" } }, "maxReviews": { "title": "Maximum reviews per activity", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum matching reviews returned for every activity. The Actor keeps paginating when filters exclude reviews.", "default": 100 }, "sortBy": { "title": "Sort order", "enum": [ "MOST_RECENT", "MOST_RELEVANT" ], "type": "string", "description": "Order reviews by publication time or Headout relevance.", "default": "MOST_RECENT" }, "language": { "title": "Translation language", "enum": [ "EN", "ES", "FR", "IT", "DE", "PT", "NL" ], "type": "string", "description": "Language Headout should use for translatedContent. Original content and sourceLanguage are preserved.", "default": "EN" }, "ratings": { "title": "Star ratings", "uniqueItems": true, "type": "array", "description": "Return only reviews with these ratings. Leave empty for all ratings.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] }, "default": [] }, "sourceLanguages": { "title": "Original review languages", "type": "array", "description": "Optional source-language codes such as EN, IT, DE, or FR. Leave empty for all languages.", "default": [], "items": { "type": "string" } }, "withImagesOnly": { "title": "Reviews with images only", "type": "boolean", "description": "Return only reviews containing customer-uploaded media.", "default": false }, "cutoffDate": { "title": "Published on or after", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional ISO date such as 2026-07-01. Older reviews are skipped." }, "aggregateRatings": { "title": "Include aggregate ratings", "type": "boolean", "description": "For activity URL inputs, fetch the page and add its average rating, counts, and star distribution to each output row.", "default": false } } }, "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 } } } } } } } } } }