{
  "openapi": "3.0.1",
  "info": {
    "title": "Hotel Review Insights: Guest Topics, Sentiment & Ratings",
    "description": "Guest opinion of hotels from Google Hotels: the topics guests write about (service, rooms, breakfast, cleanliness) with positive and negative counts, ratings on Tripadvisor and other sites, quoted reviews, and a benchmark of a whole city. Not affiliated with Google.",
    "version": "0.1",
    "x-build-id": "btu2EUJoNo9k3gcSW"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/aleksandrbooking~hotel-review-insights/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-aleksandrbooking-hotel-review-insights",
        "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/aleksandrbooking~hotel-review-insights/runs": {
      "post": {
        "operationId": "runs-sync-aleksandrbooking-hotel-review-insights",
        "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/aleksandrbooking~hotel-review-insights/run-sync": {
      "post": {
        "operationId": "run-sync-aleksandrbooking-hotel-review-insights",
        "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": {
          "searchQueries": {
            "title": "Searches",
            "type": "array",
            "description": "What you would type into Google Hotels: \"hotels in Batumi\", \"boutique hotels in Lisbon\", \"hostels near Shinjuku\". Google lists about twenty hotels per request in a changing order, so each text is asked a few times and the new hotels are kept; a big city gives fifty to sixty hotels per text at most.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "hotels": {
            "title": "Hotels",
            "type": "array",
            "description": "Hotels to look up by name with the city (\"Hilton Batumi\") or by their Google Hotels link (the address that has /entity/ in it). A name that matches no hotel well enough is listed in FAILED_HOTELS and is not charged.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "maxHotelsPerSearch": {
            "title": "Hotels per search",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "How many hotels to collect for each search text. Twenty is one page from Google; a text with fewer hotels than this returns them all.",
            "default": 30
          },
          "maxHotels": {
            "title": "Hotels per run",
            "minimum": 1,
            "maximum": 2000,
            "type": "integer",
            "description": "The most hotels the run delivers (and charges for). The run stops reading when it has this many.",
            "default": 100
          },
          "minReviews": {
            "title": "Minimum reviews",
            "minimum": 0,
            "type": "integer",
            "description": "Leave out hotels with fewer Google reviews than this. A hotel with a handful of reviews has no topics to report. Applied before the hotel is read, so a hotel left out costs nothing.",
            "default": 10
          },
          "minStars": {
            "title": "Minimum stars",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Leave out hotels with fewer stars, and hotels with no star class."
          },
          "excludeVacationRentals": {
            "title": "Leave out vacation rentals",
            "type": "boolean",
            "description": "Leave out listings of rental marketplaces (apartments and houses listed by their platform). They have a few reviews and no topics.",
            "default": true
          },
          "readHotelPages": {
            "title": "Read each hotel's Google page",
            "type": "boolean",
            "description": "One request per hotel to its Google Hotels page: every topic (often 15 to 30), the ratings on other travel sites, the lines about what guests praised and the quoted reviews. Off: only what the search card shows, which is the first six topics and nothing from other sites, but twenty hotels per request.",
            "default": true
          },
          "minMentions": {
            "title": "Minimum mentions",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "A topic needs at least this many mentions to count as praised or criticised in a row, and to count in the market benchmark. Raise it to keep only what many guests agree on.",
            "default": 10
          },
          "includeReviewSamples": {
            "title": "Include quoted reviews",
            "type": "boolean",
            "description": "Add up to twelve reviews Google quotes on the hotel's page (Google's first, then the other sites'), with author, rating, date and text. Off: topics and ratings only.",
            "default": true
          },
          "language": {
            "title": "Language",
            "enum": [
              "en",
              "en-GB",
              "de",
              "fr",
              "es",
              "it",
              "pt-BR",
              "pt-PT",
              "nl",
              "pl",
              "cs",
              "tr",
              "ru",
              "uk",
              "ja",
              "ko",
              "zh-CN",
              "zh-TW",
              "ar",
              "he",
              "th",
              "vi",
              "id",
              "sv",
              "da",
              "no",
              "fi",
              "el",
              "ro",
              "hu"
            ],
            "type": "string",
            "description": "The language of the texts Google returns, which includes the names of the topics (\"Service\", \"Servicio\", \"Service\"). Keep one language across runs you compare. English is the default.",
            "default": "en"
          },
          "country": {
            "title": "Country of sale",
            "type": "string",
            "description": "The two-letter country code Google answers for: us, gb, de, ge. It changes which other travel sites Google shows ratings of. It is not the country of the hotel.",
            "default": "us"
          },
          "concurrency": {
            "title": "Requests in parallel",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many requests run at the same time, across the whole run. The default is gentle on Google and quick enough.",
            "default": 5
          },
          "customData": {
            "title": "Custom data",
            "type": "object",
            "description": "Any JSON. It is copied onto every row, so rows of different runs can be told apart after merging."
          },
          "proxy": {
            "title": "Proxy",
            "type": "object",
            "description": "Apify datacenter proxies are the default and what this Actor is priced on. Residential groups are not available here; a run that asks for one is refused in the first seconds, before any hotel is charged. For your own proxies choose Custom proxies and supply them.",
            "default": {
              "useApifyProxy": true
            }
          },
          "dryRun": {
            "title": "Dry run (owner only)",
            "type": "boolean",
            "description": "Produce data without charging events. Honored only for runs started by the Actor owner; ignored for everyone else.",
            "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
                  },
                  "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}