SurveyResponse

  • The survey response includes a rating and optional text feedback from the user.

  • Each survey response is associated with a specific survey, conversation, and timestamp of response.

  • The response provides details about the specific question answered, including its ID, the user's text response or postback data, and the question's type and index within the survey.

  • Information about the overall survey is included, such as the total question count and how the survey was triggered.

A survey response.

JSON representation 
{
  "survey": string,
  "rating": enum (SurveyRating),
  "feedback": string,
  "createTime": string,
  "surveyQuestionId": string,
  "questionResponseText": string,
  "questionResponsePostbackData": string,
  "questionType": enum (SurveyQuestionType),
  "questionIndex": integer,
  "totalQuestionCount": integer,
  "surveyTriggerSource": enum (SurveyTriggerSource)
}
Fields
survey

string

The survey that was sent to the user. Resolves to "conversations/{conversationId}/surveys/{surveyId}", where {conversationId} is the unique ID for the conversation and {surveyId} is the unique ID for the survey.
rating

enum (SurveyRating)

A rating from the user.
feedback

string

Text feedback from the user.

Optional.
createTime

string (Timestamp format)

The time that the survey was responded.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
surveyQuestionId

string

The unique identifier of the question.
questionResponseText

string

The text that the user tapped as the question response.
questionResponsePostbackData

string

The postback data for the question response the user tapped
questionType

enum (SurveyQuestionType)

Type of the question.
questionIndex

integer

The index of the question in the survey.
totalQuestionCount

integer

The number of total questions in the survey.
surveyTriggerSource

enum (SurveyTriggerSource)

The trigger source of the survey.