ReferenceReviews

aggregatedReviews query

Retrieves aggregated (average) ratings by Expedia brand site and review category. The query enables partners to retrieve all aggregated ratings or retrieve ratings by brand site. Note that at least one review must exist for the property in order for this query to return data.

Syntax

1query {
2 property(
3 id: String!,
4 idSource: IdSource
5 ){
6 aggregatedReviews(
7 filters: {brandNames: [ReviewBrand!]!}
9 }
10}

Examples

This section provides an interactive GraphQL explorer that enables you to run a sample query, which shows how to retrieve all aggregated ratings collected from the Expedia and Orbitz sites. A test property ID is passed into the explorer; its test data is returned. The GraphQL explorer will help you get comfortable with the GraphQL:

  • For each query, a test property ID is passed into the explorer; its test data is returned.
  • Click Run Query to execute the query in the explorer on the page. You can modify the query to retrieve the desired fields, and the explorer provides a list of fields when you start typing.
  • Click API Explorer to launch the full explorer in another tab/window, which provides syntax highlighting, schema introspection, real-time error highlighting, and auto-completion, among other things.

Response

Arguments

NameDescription

id

Required.

Expedia ID (EID) or supplier ID (external ID in the partner's system) of the property.

If specifying the supplier ID for a Vrbo property, specify the ID in this format: systemId/advertiserId/listingExternalId.

  • For direct PM integrations, the value of systemId is “PM”.
  • For PMS integrations, this value represents the PMS originating the request.

If you are unsure of your system ID, contact your Engagement Manager or Technical Relationship Manager.

Type: String

idSource

Source system of the ID. EXPEDIA is the default value.

Type: IdSource

Types


Name
Type
AggregatedReviewBrandScore
Object

Rating details by brand (website) where the reviews were collected.

FieldDescription
brandNameNot nullable.

Brand to which the aggregated score belongs.

Type: ReviewBrand
categoriesWithScoreNot nullable.

Aggregated (average) rating for each category of the review.

Type: Array of non nullable ReviewCategoryScore
totalReviewsCountNot nullable.

Total number of reviews collected.

Type: Int
AggregatedReviewsFiltersInput
InputObject

Parameters to filter aggregated ratings.

FieldDescription
brandNamesNot nullable.

Brands (websites) where the reviews were collected.

Type: Array of non nullable ReviewBrand
AggregatedReviewsResponse
Object

Details about the aggregated ratings.

FieldDescription
brandsWithScoresNot nullable.

Details by brand (website) where the reviews were collected.

Type: Array of non nullable AggregatedReviewBrandScore
Float
Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

IdSource
Enum

Source of a given ID.

NameDescription
EXPEDIA

Expedia is the source of the ID.

SUPPLIER

Connectivity provider or lodging partner is the source of the ID. This value is not supported for use in promotions.

VRBO

Unsupported.

Int
Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Property
Object

Representation of a physical property, including its units, reservations, and promotions.

FieldDescription
aggregatedReviews

Aggregated (average) ratings for the property. You can filter the results by brand name (website) using the filters argument (AggregatedReviewsFiltersInput input type).

Type: AggregatedReviewsResponse
ReviewAggregatedScore
Object

Aggregated score (rating) and the number of reviews used to compute the score.

FieldDescription
reviewsCountNot nullable.

Number of reviews that were averaged to create the aggregated rating.

Type: Int
scoreNot nullable.

Aggregated (average) rating.

Type: Float
ReviewBrand
Enum

Brand names (sites) where reviews are collected.

NameDescription
EXPEDIA
HOTELS
TRAVELOCITY
ORBITZ
CHEAP_TICKETS
WOTIF
EBOOKERS
MR_JET
LASTMINUTE
VRBO

Unsupported

HOTWIRE
OTHER

Unsupported

ReviewCategoryScore
Object

Category and aggregated rating.

FieldDescription
categoryNot nullable.

Category to which the rating applies. For reviews collected on Expedia sites, these are the categories:

  • ecoFriendliness
  • roomComfort
  • roomCleanliness
  • service
  • overall
  • hotelCondition
  • roomAmenitiesScore
  • areaAroundHotel

For reviews collected on Vrbo, these are the categories:

  • checkIn
  • overall
  • location
  • communication
  • onlineListing
  • cleanliness
Type: String
valueNot nullable.

Value of the aggregated (average) rating.

Type: ReviewAggregatedScore
String
String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.