{ "openapi": "3.0.1", "info": { "title": "TripAdvisor Property Rank & Competitor Benchmark Tracker", "description": "For hotel operators, restaurant owners, and travel agencies. Tracks daily rank, rating drift, review volume, owner response rate, Travelers' Choice status, claim status, price tier, and amenities for any TripAdvisor hotel, restaurant, or attraction. One row per property. Pay per snapshot.", "version": "0.1", "x-build-id": "RQsh6xMqmIkUVDAw7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapemint~tripadvisor-property-rank-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapemint-tripadvisor-property-rank-tracker", "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/scrapemint~tripadvisor-property-rank-tracker/runs": { "post": { "operationId": "runs-sync-scrapemint-tripadvisor-property-rank-tracker", "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/scrapemint~tripadvisor-property-rank-tracker/run-sync": { "post": { "operationId": "run-sync-scrapemint-tripadvisor-property-rank-tracker", "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": { "targetUrls": { "title": "Property URLs", "type": "array", "description": "TripAdvisor property URLs. Hotel_Review, Restaurant_Review, or Attraction_Review pages. Each is snapshotted as one dataset row. Example: 'https://www.tripadvisor.com/Hotel_Review-g60763-d93589-Reviews-The_Pierre_A_Taj_Hotel.html'.", "default": [], "items": { "type": "string" } }, "destinationUrls": { "title": "Destination listing URLs", "type": "array", "description": "TripAdvisor destination listing URLs to sweep top N properties from. Hotels-, Restaurants-, or Attractions- pages. Example: 'https://www.tripadvisor.com/Hotels-g60763-New_York_City_New_York-Hotels.html'.", "default": [], "items": { "type": "string" } }, "maxPerDestination": { "title": "Max properties per destination URL", "minimum": 1, "maximum": 200, "type": "integer", "description": "When destination listing URLs are provided, snapshot at most this many top ranked properties per destination. Useful for daily competitor sweeps.", "default": 25 }, "responseRateSampleSize": { "title": "Response rate sample size", "minimum": 0, "maximum": 200, "type": "integer", "description": "Number of recent reviews to sample on each property to compute owner response rate. Bigger samples are more accurate but cost more time. Set to 0 to skip response rate.", "default": 30 }, "extractAmenities": { "title": "Extract amenities and features", "type": "boolean", "description": "Pull the amenity and feature flags TripAdvisor lists on the property page. Adds 200 to 400 ms per property. Built in. No extra cost.", "default": true }, "extractRatingHistogram": { "title": "Extract rating histogram", "type": "boolean", "description": "Capture the count of reviews at each star tier (5, 4, 3, 2, 1). Built in. No extra cost.", "default": true }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 12, "type": "integer", "description": "Number of properties processed in parallel. TripAdvisor sits behind Cloudflare, so two to four is the safe range with residential proxy.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy. Residential is required for TripAdvisor at any meaningful volume.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }