Reviews

Reviews are aggregated, so the ones that have been collected for other organisations may be included.
Only published reviews are included.

Request

GET /v4/organisations/:trkref/reviews?locale=:locale&sku=:sku

This URL: /v4/organisations;trkref=D10/reviewables;locale=en-GB;sku=AIPTPDV5700/reviews is deprecated.
Please switch to the current URL above.

Parameters

Parameter Requirement Description
trkref mandatory  
locale mandatory  
branch_code optional  
sku optional  
region optional see below
page optional  
per_page optional default: 15, max: 30

Additional parameters are available for some of our automotive clients. Please contact your account manager if you would like to access these parameters.

Possible region parameter values for non-automotive reviews

Value Description
my-locale Return all reviews having same locale as locale parameter
my-country Return all reviews having same country code as locale parameter
my-languages Return all reviews having same language code as locale parameter
english  
worldwide  

Possible region parameter values for automotive reviews

Value Description
my-locale Return all reviews having same locale as locale parameter
my-country Return all reviews having same country code as locale parameter
my-languages Return all reviews having same language code as locale parameter
multi-country Return all reviews having locale in same region as locale parameter

Response

Attributes

Attribute Description
summary  
pagination  
total_entries total number of reviews
total_entries_with_content total number of reviews with good/bad points or general comments
total_pages  
current_page  
per_page  
previous_page  
next_page  
regions  
default default region selection
current current region selection
available array of regions from which is possible to select.
reviews array of review objects (attributes described in review detail doc)

Example

GET /v4/organisations/D10/reviews?locale=en-GB&sku=AIPTPDV5700

{
   "summary":{
      "facets":[
         {
            "question_id":30,
            "translation_key":"questionnaire.question_texts.performance.question_text",
            "display_text":"Performance",
            "is_active":true,
            "is_public":true,
            "tag":null,
            "statistics":{
               "summation":786.0,
               "respondents":88
            }
         },
         {
            "question_id":37,
            "translation_key":"questionnaire.question_texts.reliability.question_text",
            "display_text":"Reliability",
            "is_active":true,
            "is_public":true,
            "tag":null,
            "statistics":{
               "summation":742.0,
               "respondents":84
            }
         },
         {
            "question_id":38,
            "translation_key":"questionnaire.question_texts.capacity.question_text",
            "display_text":"Capacity",
            "is_active":true,
            "is_public":true,
            "tag":null,
            "statistics":{
               "summation":804.0,
               "respondents":88
            }
         },
         {
            "question_id":7,
            "translation_key":"questionnaire.question_texts.value_for_money.question_text",
            "display_text":"Value for money",
            "is_active":true,
            "is_public":true,
            "tag":"value-for-money",
            "statistics":{
               "summation":961.0,
               "respondents":105
            }
         },
         {
            "question_id":8,
            "translation_key":"questionnaire.question_texts.overall_rating.question_text",
            "display_text":"Overall rating",
            "is_active":true,
            "is_public":true,
            "tag":"overall",
            "statistics":{
               "summation":960.0,
               "respondents":106
            }
         }
      ],
      "pagination":{
         "total_entries":106,
         "total_entries_with_content":73,
         "total_pages":8,
         "current_page":1,
         "per_page":15,
         "previous_page":null,
         "next_page":2
      },
      "regions": {
         "default": "my-country",
         "current": "my-country",
         "available": [
            {
               "key": "my-country",
               "translation_key": "reviews_tab.automotive_regions.my-country",
               "number_of_reviews": 6633,
               "in_native_language": true
            },
            {
               "key": "multi-country",
               "translation_key": "reviews_tab.automotive_regions.multi-country",
               "number_of_reviews": 6906,
               "in_native_language": false
            }
         ]
      }
   },
   "reviews":[
      {
         "id":5996122,
         "overall_score":9,
         "helpful":0,
         "not_helpful":0,
         "good_points":"For the money excellent value.",
         "bad_points":"Still too early for a proper evaluation\r\nNone as yet",
         "general_comments":null,
         "product": {
            "id": 1462,
            "name": "PlayStation 4",
            "image_url": "//images.reevoo.com/retailer_products/1462/10207581/37x37.jpg?timestamp=1439805440"
         },
         "retailer_product": {
            "name": "Retailer product example",
            "sku": "SKU example"
         },
         "fast_responses": [
            {
               "response": "Example response",
               "respondent": {
                  "custom_name": "Custommer service",
                  "first_name": "John",
                  "surname": "Brown",
                  "job_title": "job title",
                  "display_name": "Customer service"
               },
               "organisation": {
                  "trkref": "TRKREF",
                  "name": "Organisation Name",
                  "logo": "http://images.reevoo.com/retailers/image2.png"
               }
            }
         ],
         "customer_ref": "12345678",
         "order_ref": "87654321",
         "embeddable": false,
         "reviewer":{
            "first_name":"Robert",
            "location":"Catford, London",
            "segment":"Home user",
            "facebook_avatar_url":null
         },
         "facets":[
            {
               "question_id":30,
               "translation_key":"questionnaire.question_texts.performance.question_text",
               "display_text":"Performance",
               "is_active":true,
               "is_public":true,
               "tag":null,
               "statistics":{
                  "summation":9.0,
                  "respondents":1
               }
            },
            {
               "question_id":37,
               "translation_key":"questionnaire.question_texts.reliability.question_text",
               "display_text":"Reliability",
               "is_active":true,
               "is_public":true,
               "tag":null,
               "statistics":{
                  "summation":9.0,
                  "respondents":1
               }
            },
            ...
         ]
      },
      ...
   ]
}