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(5 ){6 aggregatedReviews(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.
Reviews
API ExplorerResponse
Arguments
Name | Description |
---|---|
| 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:
If you are unsure of your system ID, contact your Engagement Manager or Technical Relationship Manager. Type: String |
| 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.
| ||||||||||||||||||||||||||||
AggregatedReviewsFiltersInput | InputObject | |||||||||||||||||||||||||||
Parameters to filter aggregated ratings.
| ||||||||||||||||||||||||||||
AggregatedReviewsResponse | Object | |||||||||||||||||||||||||||
Details about the aggregated ratings.
| ||||||||||||||||||||||||||||
Float | Float | |||||||||||||||||||||||||||
The | ||||||||||||||||||||||||||||
IdSource | Enum | |||||||||||||||||||||||||||
Source of a given ID.
| ||||||||||||||||||||||||||||
Int | Int | |||||||||||||||||||||||||||
The | ||||||||||||||||||||||||||||
Property | Object | |||||||||||||||||||||||||||
Representation of a physical property, including its units, reservations, and promotions.
| ||||||||||||||||||||||||||||
ReviewAggregatedScore | Object | |||||||||||||||||||||||||||
ReviewBrand | Enum | |||||||||||||||||||||||||||
Brand names (sites) where reviews are collected.
| ||||||||||||||||||||||||||||
ReviewCategoryScore | Object | |||||||||||||||||||||||||||
Category and aggregated rating.
| ||||||||||||||||||||||||||||
String | String | |||||||||||||||||||||||||||
The |