Sign in

v1

latestOpenAPI 3.0.02026-08-067074272.5 KB
Reviews

Retrieves all reviews in a dashboard.

As many as all filter parameters and as few as none may be set. Only the dashboard specified will be searched; reviews are organized by dashboard. There is no account level search for a number available.

get/dashboards/{dashboard_id}/reviews

Path parameters

dashboard_idinteger required
Example:121

Id of dashboard

Query parameters

start_datestring date-time
end_datestring date-time
pageinteger

The page number. The first item returned will be page multiplied by page_size

page_sizeinteger

The number of items returned. The first item returned will be page multiplied by page_size

Response

A list of reviews.

Example response

{
  "meta": {
    "total_items": 172
  },
  "items": [
    {
      "id": 508,
      "platform": "Facebook",
      "review_message": "Fantastic service. 10 out of 10!",
      "reviewer_name": "Robert Smith",
      "is_positive_recommendation": true,
      "resopnse_message": "Glad you enjoyed your time! We hope you will come again.",
      "source": "requested",
      "campaign_id": 1042,
      "campaign_name": "First-time Customers Reviews"
    }
  ]
}