Introduction

The ReviewsAPI facilitates extensive monitoring of review data for 2m+ hotels worldwide, including textual content of reviews, numerical scoring associated with the reviews, and sentiment analysis indicating the sentiment expressed in the reviews. Every day, thousands of customers rely on our ReviewsAPI to monitor customer feedback, improve their brand’s online presence, and monitor competitor reviews. Users have the flexibility to choose between scheduling extraction requests at specific intervals or making real-time requests to fetch the latest reviews and related data. Our ReviewsAPI integration is fully scalable, accurate and provides a fast and easy solution that can help you stay ahead of the competition.

The ReviewsAPI follows a REST architecture, providing a structured approach to accessing its resources. It utilizes resource-oriented URLs, accepts request bodies primarily in JSON format, returns responses encoded in JSON, and adheres to standard HTTP response codes, authentication methods, and HTTP verbs.

The API's endpoints can be broadly categorized into the following modules:

Review API is a Review data fetching service.It enables you to request and schedule ('create shops') reviews data and scoring ('rating') for specific hotels and from specific sources. Hotel rating and review data provides insights to the quality, service, and overall guest experience of a hotel. This data typically includes:

Ratings: Numerical scores assigned to hotels. Ratings are presented as total for property and per their categories such as cleanliness, location, service, amenities etc.

Reviews: Full review content from guests sharing their personal experiences, opinions, and recommendations.

Sentiment Analysis: The process of identifying and categorizing the emotional tone of reviews (positive, negative, or neutral).

This Swagger document outlines the methods organized into the following groups for interacting with the ReviewsAPI.

Authentication - Gain access to the API using authentication methods

Hotel Information - Search for hotels and retrieve detailed hotel information

Review Shops - Manage shop configurations for reviews

Review Schedules - Set up a schedule to run a Review Shop

Reviews and Ratings Information - Fetch ratings and review information for hotels

Hooks - Define the endpoint to receive Shop alerts

Synopsis - Fetch reviews count for the last one year

References - Retrieve reference values used in ReviewsAPI

Time Zone - All timestamps and time-related values returned by the API are in Coordinated Universal Time (UTC).

This Swagger Explorer offers an environment for users to test all methods by passing the appropriate parameters outlined in this document. It functions exactly as it would within the application, allowing users to evaluate different combinations of parameter values and explore various use cases.

Authorization

Each request to the Reviews API must be authenticated with an access token. You can obtain this token by logging in with the credentials provided in your ReviewsAPI packet. The access token is valid for 24 hours from the time of generation.The access token must be included in the 'Authorization' header, as shown in the example below:

If your access token is A90324XXZUZUgpO0dd6npHcM83CJ..., every request should include the following header:

In summary, the ReviewsAPI adopts a RESTful design, offering well-defined endpoints and adhering to standard practices for resource access and manipulation. Its modules cover user authentication, source exploration, dependency retrieval, schedule management, and shop-specific data extraction for hotel reviews.

Web: Aggregate Intelligence Inc.

API Modules

The ReviewsAPI V2.0 endpoints may broadly be categorized into the following modules: