Review API v2

_{You will need an}_{API key}_{for authorizing your requests. You can request an API key from our Customer Care team.}
_{The API key must be passed in an HTTP header named}_X-CA-AUTH_{when requesting any of the API endpoints.}

^{The default endpoint is}^{https://api.customer-alliance.com}^{, if not stated differently.}

Reviews

GET /reviews/v2/ca.json

The new version of the Review API is available here

API allows access to the data that was collected via Customer Alliance review questionnaires. This may include information such as:

Review content;
Average rating;
Information about the guest leaving the review.

Parameters

All parameters are optional.

Name	Default value	Description

Name	Default value	Description
`page`	1	Integer greater than or equal to 1. The number of reviews per request is limited to the value of limit, this parameter is responsible for pagination.
`start`	180 days before the end date	Date in the YYYY-MM-DD format. Use this to select the earliest review you wish to see.
`end`	today	Date in the YYYY-MM-DD format. Must not be earlier than the value of start. Use this to select the latest review you wish to see.
`category`	'average'	A valid review rating category, also known as a 'criteria'. A list of categories can be seen in the response of this endpoint without supplying the parameters. Use this to filter reviews by subcategory, e.g, ‘price’, ‘breakfast’, etc.
`fromRating`	0	Integer between 0 and 100. The lowest review score you wish included in the result set.
`toRating`	100	Integer between 0 and 100. The highest review score you wish included in the result set.
`commentStatus`	no value	Must be one of: `commented` `not_commented` `drafted` Filters reviews as to whether they have been commented, not commented or have had a comment drafted.
`categoryRatings`	0	Either 1 or 0.
`published`	0	Either 1 or 0. If the published parameter is added with value 1. The results will only contain reviews that have been published (public reviews).
`limit`	20	The number of reviews shown per page.

Examples

Shell

curl --header "X-CA-AUTH: <YOUR_API_KEY_HERE>" https://api.customer-alliance.com/reviews/v2/ca.json?page=1&start=2021-01-01&end=2021-01-13&fromRating=0&toRating=100&categoryRatings=1&published=0&limit=20

Response

{
    "totalCount": 1,
    "reviews": [
        {
            "hotel_name": "Restaurant The Eagle",
            "review_id": "careview52326183",
            "review_source": "customeralliance",
            "average_rating_normalized": "90.0000",
            "average_rating": "4.5000",
            "reviewer_type": null,
            "language": "en",
            "published": false,
            "reviewer_comment": "It was a nice experience, definitely worth coming again",
            "reviewer_comment_positive": "",
            "reviewer_comment_negative": "",
            "arrival_date": "2021-01-09",
            "departure_date": "2021-01-09",
            "review_date": "2021-01-12 09:07:46",
            "author": "Customer Alliance u.",
            "category_ratings": {
                "price": {
                    "rating": 80,
                    "label": "Price",
                    "comment": null
                },
                "service": {
                    "rating": 100,
                    "label": "Service",
                    "comment": null
                },
                "FoodQuality": {
                    "rating": 100,
                    "label": "Quality of Food",
                    "comment": null
                },
                "Atmosphere": {
                    "rating": 80,
                    "label": "Atmosphere",
                    "comment": null
                }
            },
            "nps": 9,
            "brand_nps": null,
            "age": 30,
            "hotelier_comment": null
        }
    ]
}

GET /reviews/v2/all.json

Review data collected via Customer Alliance questionnaires and reviews from external portals, such as Google, Facebook, or Tripadvisor.

Parameters

All parameters are optional.

Name	Default value	Description

Name	Default value	Description
`page`	1	Integer greater than or equal to 1. The number of reviews per request is limited to the value of limit, this parameter is responsible for pagination.
`start`	180 days before the end date	Date in the YYYY-MM-DD format. Use this to select the earliest review you wish to see.
`end`	today	Date in the YYYY-MM-DD format. Must not be earlier than the value of start. Use this to select the latest review you wish to see.
`fromRating`	0	Integer between 0 and 100. The lowest review score you wish included in the result set.
`toRating`	100	Integer between 0 and 100. The highest review score you wish included in the result set.
`commentStatus`	no value	Must be one of: `commented` `not_commented` `drafted` Filters reviews as to whether they have been commented, not commented or have had a comment drafted.
`published`	0	Either 1 or 0. If the published parameter is added with value 1. The results will only contain reviews that have been published (public reviews).
`limit`	20	The number of reviews shown per page.

Examples

Shell

curl --header "X-CA-AUTH: <YOUR_API_KEY_HERE>" https://api.customer-alliance.com/reviews/v2/all.json?page=1&start=2021-01-01&end=2021-01-12&fromRating=80&toRating=100

Response

Please note that we have the latest version (V3) available here https://customer-alliance.atlassian.net/wiki/spaces/CAA/pages/3126427664

Statistics

GET /statistics/v1/categories.json

Shows the rating categories currently used for aggregation on your API key.
The data refreshes every 2 hours.

Parameters

All parameters are optional.

Name	Default value	Description

Name	Default value	Description
`review_subject`	First created review subject	It refers to Review Config's hash value. By default access key has access to 100 review subjects, by using "review_subject" parameter you can specify for which subject you would like to retrieve data. Must be a value from 'hash' field, looks like: e3600bf31c28b60e

Examples

Shell

Response

GET /statistics/v2/general/recent.json

Shows statistics for rating categories, including the overall category, for all reviews authored in the past 6 months.

Parameters

All parameters are optional.

Name	Default value	Description

Name

Default value

Description

_locale

en

Changes the language used to show the category labels.

Must be a valid ISO 3166-1 alpha-2 language code. For example: 'en' for English, 'fr' for French.

review_subject

First created review subject

It refers to Review Config's hash value. By default access key has access to 100 review subjects, by using "review_subject" parameter you can specify for which subject you would like to retrieve data.
Must be a value from 'hash' field, looks like: e3600bf31c28b60e

published

no value

Possible values: either 0 or 1.

If set to 1 will return only data about published reviews (public reviews).

Examples

Shell

Response

GET /statistics/v2/general/total.json

Shows statistics for rating categories, including the overall category, for all known reviews.

If the parameter 'review_subject' is not set, the statistics will be shown for the first created review subject of the api-key.

Parameters

All parameters are optional.

Name	Default value	Description

Name

Default value

Description

_locale

en

Changes the language used to show the category labels.

Must be a valid ISO 3166-1 alpha-2 language code. For example: 'en' for English, 'fr' for French.

review_subject

first created review subject

It refers to Review Config's hash value. By default access key has access to 100 review subjects, by using "review_subject" parameter you can specify for which subject you would like to retrieve data.
Must be a value from 'hash' field, looks like: e3600bf31c28b60e

published

no value

Possible values: either 0 or 1.

If set to 1 will return only data about published reviews (public reviews).

Reviews

GET /reviews/v2/ca.json

Parameters

Name

Default value

Description

Name

Default value

Description

Examples

Shell

Response

GET /reviews/v2/all.json

Parameters

Name

Default value

Description

Name

Default value

Description

Examples

Shell

Response

Statistics

GET /statistics/v1/categories.json

Parameters

Name

Default value

Description

Name

Default value

Description

Examples

Shell

Response

GET /statistics/v2/general/recent.json

Parameters

Name

Default value

Description

Name

Default value

Description

Examples

Shell

Response

GET /statistics/v2/general/total.json

Parameters

Name

Default value

Description

Name

Default value

Description

Examples

Shell

Response

Feedbacks

Monitoring

Guests