v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB

Satisfaction Surveys

Retrieve a survey

get/api/satisfaction-surveys/{id}

Path parameters

idinteger required

The ID of the survey to retrieve.

Response

The requested survey.

idinteger

ID of the survey.

body_textstring nullable

The comment sent by the customer.

created_datetimestring date-time nullable

When the survey was created.

customer_idinteger

The ID of the customer who filled the survey.

metaobject nullable

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.

scoreinteger nullable

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

scored_datetimestring date-time nullable

When the survey was filled by the customer.

sent_datetimestring date-time nullable

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

should_send_datetimestring date-time nullable

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

ticket_idinteger

The ID of the ticket the survey is associated with.

uristring

URI of the survey.

Example response

{
  "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
}