Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Info

You will need an API key for authorizing your requests. You can request an API key from our Customer 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.

...

Expand
titleGET review-subjects

GET /review-subjects

Share the list of review subjects linked to the API Key

Parameters

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

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

Response

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

...

Expand
titleGET questionnaires

GET /questionnaires

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

Parameters

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.

reviewSubjects

--

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

Examples

Shell

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

Response

Code Block
[
   {
      "pagination":{
         "current_page":1,
         "total_pages":1,
         "total_items":2
      },
      {
         "id":699083,
         "name":"Breakfast Survey",
         "enabled":true,
         "review_subject":
         {
            "hash":"asdlfh345345ASDF23svcsdvsd",
            "name":"Hotel John"
         }
      },
      {
         "id":699093,
         "name":"During Stay Feedback",
         "enabled":false,
         "review_subject":
         {
            "hash":"YBJFFasd4334rsadvvasd232d23d",
            "name":"Hotel Wick"
         }
      }
   ]

...

Expand
titleGET /reviews/v3

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

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.

reviewSubjects

--

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

Examples

Shell

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

Response

Code Block
languagejson
{
    "pagination": {
        "current_page": 1,
        "total_pages": 1,
        "total_items": 1
    },
    "items": [
        {
            "id": 52749453,
            "language": "en",
            "created_date": "2021-02-18 12:25:52",
            "author": {
                "name": "John",
                "email": "john@email.com"
            },
            "meta": {
                "traveller_type": null,
                "age": null,
                "arrival_date": "2021-02-01",
                "departure_date": "2021-02-28",
                "attributes": {
                    "room_number": "666",
                    "pms_reservation_id": "1234",
                    "some_custom_attribute": "some_value"
                }
            },
            "questionnaire": {
                "id": 699083,
                "name": "Breakfast Survey"
            },
            "review_subject": {
                "hash": "asdlfh345345ASDF23svcsdvsd",
                "name": "Hotel John"
            },
            "overall_rating": {
                "scaled": 5,
                "rating_scale": {
                    "min": 1,
                    "max": 5
                },
                "normalized": 100
            },
            "overall_comment": "some nice text comment",
            "reply": "thank you for the review!",
            "category_ratings": [
                {
                    "rating_category": "service",
                    "rating": {
                        "scaled": 5,
                        "rating_scale": {
                            "min": 1,
                            "max": 5
                        },
                        "normalized": 100
                    }
                },
                {
                    "rating_category": "food_and_beverages",
                    "rating": {
                        "scaled": 3.5,
                        "rating_scale": {
                            "min": 1,
                            "max": 5
                        },
                        "normalized": 70
                    }
                }
            ],
            "question_answers": [
                {
                    "question": {
                        "id": 11918603,
                        "type": "csat",
                        "label": "Service",
                        "rating_category": "service",
                        "rating_scale": {
                            "min": 1,
                            "max": 5
                        }
                    },
                    "answer": {
                        "rating": 5,
                        "text": null
                    },
                    "sub_question_answers": []
                },
                {
                    "question": {
                        "id": 11918603,
                        "type": "ces",
                        "label": "We made it easy for you to check-in",
                        "rating_category": "ces_checkin",
                        "rating_scale": {
                            "min": 1,
                            "max": 7
                        }
                    },
                    "answer": {
                        "rating": 5,
                        "text": null
                    },
                    "sub_question_answers": []
                },
                {
                    "question": {
                        "id": 11918613,
                        "type": "csat",
                        "label": "Buffet / Menu selection",
                        "rating_category": "food_and_beverages",
                        "rating_scale": {
                            "min": 1,
                            "max": 5
                        }
                    },
                    "answer": {
                        "rating": 4,
                        "text": null
                    },
                    "sub_question_answers": []
                },
                {
                    "question": {
                        "id": 11918623,
                        "type": "csat",
                        "label": "Quality of food",
                        "rating_category": "quality_of_food",
                        "rating_scale": {
                            "min": 1,
                            "max": 5
                        }
                    },
                    "answer": {
                        "rating": 5,
                        "text": null
                    },
                    "sub_question_answers": []
                },
                {
                    "question": {
                        "id": 11918633,
                        "type": "csat",
                        "label": "Selection of beverages",
                        "rating_category": "food_and_beverages",
                        "rating_scale": {
                            "min": 1,
                            "max": 5
                        }
                    },
                    "answer": {
                        "rating": 3,
                        "text": null
                    },
                    "sub_question_answers": []
                },
                {
                    "question": {
                        "id": 11918643,
                        "type": "text",
                        "label": "How would you describe your overall experience?"
                    },
                    "answer": {
                        "text": "All in all it was almost perfect, except there were no apple juice."
                    },
                    "sub_question_answers": []
                },
                {
                    "question": {
                        "id": 11918653,
                        "type": "choice",
                        "label": "Are you a guest of the hotel?"
                    },
                    "answer": {
                        "choices": [
                            {
                                "label": "Yes"
                            }
                        ]
                    },
                    "sub_question_answers": [
                        {
                            "question": {
                                "id": 11918663,
                                "type": "text",
                                "label": "Your room number"
                            },
                            "answer": {
                                "text": "119"
                            },
                            "sub_question_answers": []
                        }
                    ]
                },
                {
                    "question": {
                        "id": 11918673,
                        "type": "text",
                        "label": "Your email address"
                    },
                    "answer": {
                        "text": "john@email.com"
                    },
                    "sub_question_answers": []
                },
                {
                    "question": {
                        "id": 26,
                        "type": "nps",
                        "label": "How likely are you to recommend us to a friend or colleague?",
                        "rating_scale": {
                            "min": 0,
                            "max": 10
                        }
                    },
                    "answer": {
                        "rating": 6
                    },
                    "sub_question_answers": []
                }
            ]
        }
    ]
}

 

...