Review API v3

Owned by KK (Unlicensed)
Last updated: Jul 09, 2024 by David Maicher
22 min read

 

You will need an API key for authorizing your requests. You can request an API key from our Customer Support team. 
The API key must be passed in an HTTP header named X-CA-AUTH when requesting any of the API endpoints.

 

API endpoints

Getting the review information is a 3-step process, with two optional endpoints (review-subjects in the case when the account has multiple review configs linked to one API Key).

  • [Optional] Get Review Subjects- to be used in case of multi-location account. Depending on the API key, an account can have multiple review subjects. The API returns a unique identifier for a location.

  • [Optional] Get Survey questionnaires- to be used in case of multiple questionnaires for a single review subject. The API returns a unique identifier for the questionnaire and relates a particular questionnaire to the review subject.

  • Reviews- The API returns the review information generated by the CA surveys.

 

Get Review Subjects

GET /review-subjects

Share the list of review subjects linked to the API Key

Parameters

Name
Default value
Description
Name
Default value
Description

page

1

Integer greater than or equal to 1.
The number of items per request is limited to the value of limit, this parameter is responsible for pagination.

limit

20

The number of items shown per page. Maximum value allowed is 50.

Examples

Shell

$ curl --header "X-CA-AUTH: <YOUR_API_KEY_HERE>" https://api.customer-alliance.com/review-subjects

Response

{ "pagination": { "current_page": 1, "total_pages": 1, "total_items": 2 }, "items": [ { "name": "Hotel John", "hash": "ASDFasd4334rsadvvasd232d23d2" }, { "name": "Hotel Wick", "hash": "YBJFFasd4334rsadvvasd232d23d" } ] }

Get Survey questionnaires

GET /questionnaires

Allows access to survey questionnaires (receive a list of feedback questionnaires).

Parameters

Name
Default value
Description
Name
Default value
Description

page

1

Integer greater than or equal to 1.
The number of items per request is limited to the value of limit, this parameter is responsible for pagination.

limit

20

The number of items shown per page. Maximum value allowed is 50.

reviewSubject

--

Can pass multiple review_subject.hash in case multiple review subjects are linked to the API key

Examples

Shell

$ curl --header "X-CA-AUTH: <YOUR_API_KEY_HERE>" https://api.customer-alliance.com/questionnaires

Response

Reviews

GET /reviews/v3

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

  • Review content

  • Average rating

  • Individual rating

  • Text responses including the sub-questions and conditional questions

  • Information about the guest leaving the review

Parameters

All parameters are optional.

Name
Default value
Description
Name
Default value
Description

questionnaireIds

--

A required parameter with Interger value.

Note: this parameter may be included multiple times, e.g.
questionnaireIds=1000&questionnaireIds=1001

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.

startDate

--

Date in the YYYY-MM-DD format.
Use this to select the earliest review you wish to see.

endDate

--

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

--

Integer between 0 and 100.
The lowest review score you wish included in the result set.

toRating

--

Integer between 0 and 100.
The highest review score you wish included in the result set.

categoryRatings

0

Either 1 or 0. 0 means that the category_ratings is not included in the response

questionAnswers

0

Either 1 or 0. 0 means that the question_answers is not included in the response

published

--

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. Maximum value allowed is 50.

language

--

To show the feedbacks submitted for the selected language. Values can be one of these language codes:

de, en, es, fr, nl, cs, da, hu, it, pl, pt, ru, sr, sv, ar, zh, ja, fi, no

_locale

en

Changes the language used to show the question labels.

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

reviewSubject

--

Can pass multiple review_subject.hash in case multiple review subjects are linked to the API key

Examples

Shell

Response