API Reference

The SatisfactionSurvey object

Satisfaction surveys are one of the best ways to determine how well your team is supporting your customers. Find out more about how to use them here: https://docs.gorgias.com/survey/customer-satisfaction-survey

Currently there can be only one satisfaction survey per ticket.

SatisfactionSurvey properties

integer

ID of the survey.

string | null

The comment sent by the customer.

ISO 8601 datetime

When the survey was created.

integer

The ID of the customer who filled the survey.

object | null

Data associated with the satisfaction survey. You can use this parameter to store structured information (key-value data) about the satisfaction survey. This field is not used by Gorgias.

integer | null

The level of satisfaction. Scores range from 1 to 5.

ISO 8601 datetime

When the survey was filled by the customer.

ISO 8601 datetime

When the survey was sent. If is not set it means that it was not sent yet.

ISO 8601 datetime

When the survey should be sent. If not set then the survey will not be sent by Gorgias.

integer

The ID of the ticket the survey is associated with.

string

URI of the survey.

SatisfactionSurvey example object

{
  "id": 1234,
  "body_text": "Such speed, much pertinent.",
  "created_datetime": "2019-11-16T15:59:41.966927",
  "customer_id": 120,
  "meta": {
    "externalData": {
      "id": 1234
    }
  },
  "score": 2,
  "scored_datetime": "2019-11-25T15:59:41.966927",
  "sent_datetime": "2019-11-23T15:59:41.966927",
  "should_send_datetime": "2019-11-23T15:59:41.966927",
  "ticket_id": 12,
  "uri": "/api/satisfaction-surveys/1234/"
}