Reviews

Searching

The /api/v2/reviews resource lets you search for reviews using a predefined set of filters.

Request URL:

GET /api/v2/reviews?api_key={my_api_key}

Request parameters:

Parameter Type Required Default Description
api_key string True None Your API secret key
page int True 1 Page number. 30 results per request, the page is used to loop through the results
state string False None Filter reviews by states (can have one of these values: treated / not_treated / deleted)
rating__in list<int> False None Filter reviews by ratings (int between 1 and 5, comma separated values)
rating int False None Filter reviews by one rating value (int between 1 and 5)
content__isnull boolean False None Filters the reviews with messages or without messages (bool: true / false)
partner__in list<string> False None Filter reviews by partners (“google_my_business”, “foursquare”, “facebook”)
update_date__gte date False None Return reviews which have the update date superior to the provided value
update_date__lte date False None Return reviews which have the update date superior to the provided value
business__in list<string> False None Return reviews belonging to the specified businesses
business_city string False None Return reviews belonging to all businesses located in the specified city

Notes:

  • in case the review doesn’t have an update date, the creation date will be automatically taken into account in the update_date__* filters

JSON response:

{
    "page"            : "page number (int)",
    "max_page"        : "last page number (int)",
    "count"           : "total number of reviews found (int)",
    "reviews": [
        {
            "id": "review's id on partoo side",
            "org_id": "id of the org owning the org",
            "business_id": "id of the business owning the review",
            "partner": "name of the partner (either 'google_my_business', 'foursquare', 'facebook')",
            "partner_id": "review's id on partner side",
            "author_name": "name of the review author",

            "date": "review's creation date (YYYY-MM-DDTHH:MM:ss+GMT)",
            "update_date": "review's last update date (YYYY-MM-DDTHH:MM:ss+GMT)",
            "delete_date": "review's estimated deletion date (YYYY-MM-DD)", # the exact deletion time is impossible to know
            "rating": "review's rating (an int between 1 and 5)",
            "title": "review's title",
            "content": "review's content",
            "reply_comment": "review's reply content",
            "state": "review's state (either 'treated', 'not_treated' or 'deleted')",
            "link": "link to review",
            "key": "review's ID on the partner side"
        }
    ]
}