Inbox
Shared inbox helpdesk for all your support channels. Built for your team.
Chat
Live chat with automated messaging, chatbots, and video calls for your website or web app.
Chatbots
Automate every business opportunity with pre-built and custom chatbots.
Push Campaigns
Increase re-engagement and boost sales with targeted push notification campaigns.
AI BETA
Leverage the power of AI to help you respond, create, and summarize.
FAQ
Customizable and embeddable FAQ center to help customers help themselves.
Status Page
Keep customers informed by alerting them when there’s an incident or outage.
Live
Get more sales with real time customer activity monitoring and personal messages.

Show Developer Menu

GET /satisfaction_ratings

Issuing a GET call to satisfaction_ratings will allow you to retrieve satisfaction survey ratings for the Brand

Example Request
curl 'https://{brand}.reamaze.io/api/v1/satisfaction_ratings' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json'
Example Response
{
  "page_size": 30,
  "page_count": 1,
  "total_count": 5,
  "satisfaction_ratings": [
    {
      "id": "456",
      "rating": 5,
      "comment": "Excellent service!",
      "user_id": "123",
      "assignee_id": "789",
      "conversation_id": "556",
      "created_at": "2024-01-15T10:30:00.000Z",
      "updated_at": "2024-01-15T10:30:00.000Z"
    },
    {
      "id": "789",
      "rating": 4,
      "comment": "Good support, could be faster",
      "user_id": "124",
      "assignee_id": "331",
      "conversation_id": "774",
      "created_at": "2024-01-14T14:20:00.000Z",
      "updated_at": "2024-01-14T14:20:00.000Z"
    }
  ]
}
Optional Query Parameters
  • rating - Filter by specific rating value (1-5)
  • assignee_id - Filter by assignee ID
  • created_after - Filter ratings created after this date (ISO 8601 format)
  • created_before - Filter ratings created before this date (ISO 8601 format)
  • updated_after - Filter ratings updated after this date (ISO 8601 format)
  • updated_before - Filter ratings updated before this date (ISO 8601 format)
  • page - Page number for pagination (default: 1)
Example with Query Parameters
curl 'https://{brand}.reamaze.io/api/v1/satisfaction_ratings?rating=5&assignee_id=789&updated_after=2024-01-01T00:00:00Z' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json'
Authentication & Permissions

This endpoint requires HTTP Basic Authentication using your login email and API token. The authenticated user must have the access_reports permission enabled in their role to access this endpoint. If the user lacks this permission, the API will return a HTTP 403 Forbidden response.

Error Responses
  • 403 Forbidden - Returned when the user does not have the required access_reports permission
  • 401 Unauthorized - Returned when authentication credentials are invalid
Notes
  • The rating value is an integer between 1 and 5, or null if not rated
  • The comment field contains the optional feedback provided with the rating
  • The user_id refers to the customer who provided the rating
  • The assignee_id refers to the staff member who was assigned to the conversation
  • The conversation_id links the rating to the specific conversation
  • Results are ordered by created_at in descending order (newest first)
  • Pagination is supported with a default page size of 30 items