Sign in

v1

latestOpenAPI 3.0.02026-08-067074272.5 KB
Reviews

get/dashboards/{dashboardId:int}/reviews/statistics

Path parameters

dashboard_idinteger required
Example:121

Id of dashboard

Query parameters

start_datestring date-time
end_datestring date-time
campaign_idinteger

Id of campaign

platform'TextRequest' | 'Facebook' | 'Google'

Platform of reviews to filter by

Response

A list of reviews.

ClickthroughRateinteger

The rate at which contacts click the link that is sent with a review request text, as a percentage of all review requests in the queried timespan. The percent is returned as a whole number (e.g., for a 20% clickthrough rate, the return would be 20)

ConversionRateinteger

The rate at which contacts contacts leave a thumbs-up, private feedback, or public review, as a percentage of all review requests in the queried timespan. The percent is returned as a whole number (e.g., for a 20% conversion rate, the return would be 20). This is equal to CompletedReviews/RequestsSent.

AverageTimeToConvertinteger

The average amount of time (in minutes) from when the review request is sent to when a review (private or public) is left. Review requests that do not get a review response have no effect on this calculation.

AverageScorenumber float

The average score of all reviews. If your search includes platforms with a thumbs-up/thumbs-down system, such as Facebook or private feedback (platform=TextRequest), a thumbs up represents a score of 5.0, and a thumbs down represents a score of 1.0. Review requests that do not get a review response have no effect on this calculation.

RequestsSentinteger

The number of review requests sent.

CompletedReviewsinteger

The number of reviews left as a direct result of Text Request review requests. This does not represent ALL reviews left during that time on your platforms; just the ones left by people that you sent Review Requests to before the review was left. Sometimes, a review is left on a platform anonymously, and we cannot be certain if it was left because of Text Request or not, so this number may be lower than the actual number of reviews that got left due to Text Request review requests; however, we try to keep this number as accurate as possible.

Example response

{
  "ClickthroughRate": 25,
  "ConversionRate": 25,
  "AverageTimeToConvert": 74,
  "AverageScore": 3.7,
  "RequestsSent": 480,
  "CompletedReviews": 120,
  "PlatformConversion": {
    "Text Request": {
      "conversionRate": 25,
      "totalReviewsSent": 160,
      "reviewsGained": 40
    },
    "Google": {
      "conversionRate": 25,
      "totalReviewsSent": 160,
      "reviewsGained": 40
    },
    "Facebook": {
      "conversionRate": 25,
      "totalReviewsSent": 160,
      "reviewsGained": 40
    }
  }
}