A survey is an object that represents the CSAT survey. See Sending a CSAT survey to your customers in Zendesk Help.
Surveys are available on the Support Professional plan and above, and the Zendesk Suite Growth plan and above.
CSAT Surveys are represented as JSON objects with the following properties:
created_at string false true The date and the time when the survey was created id string false true The id of the survey. Automatically assigned when the survey is created questions array false true An array of survey question objects. See Question object state string false true Whether the survey is active or deactivated. Allowed values are "enabled", or "disabled". updated_at string false true The date and the time when the survey was most recently updated version integer false true The version of the survey upon which the survey response was based on. Every time the survey is updated, the version is automatically incremented.
There are three types of question objects:
type string false false Has the value closed_ended id string false false Automatically assigned when the survey question is created headline object false false A text content object representing the headline of the survey question options array false false An array of closed-ended survey question options
id string false false Automatically assigned when the survey question option is created label object false false A text content object representing the label of the option follow_up object false true A follow up object which points to the following question
type string false false Has the value open_ended id string false false Automatically assigned when the survey question is created headline object false false A text content object representing the headline of the survey question follow_up object false true A follow up object which points to the following question
The rating scale question object can be one of the following types:
type string false false Has the value rating_scale_custom_text id string false false Automatically assigned when the survey question is created sub_type string false false One of the following values: customer_satisfaction, other headline string false false A text content object representing the headline of the survey question options array false false An array of custom text rating scale options
rating integer false false The numeric rating represented by this option label object false false A text content object representing the label of this option follow_up object false true A follow up object which points to the following question
type string false false Has the value rating_scale_emoji id string false false Automatically assigned when the survey question is created sub_type string false false One of the following values: customer_satisfaction, other headline string false false A text content object representing the headline of the survey question options array false false An array of emoji rating scale options
rating integer false false The numeric rating represented by this option emoji object false false A text content object representing the emoji of this option label object false false A text content object representing the label of this option follow_up object false true A follow up object which points to the following question
type string false false Has the value rating_scale_numeric id string false false Automatically assigned when the survey question is created sub_type string false false One of the following values: customer_satisfaction, other headline string false false A text content object representing the headline of the survey question options array false false An array of numeric rating scale options
rating integer false false The numeric rating represented by this option label object false false A text content object representing the label of this option follow_up object false true A follow up object which points to the following question
A text content object can be one of the following types:
An object containing a text string that isn't translated to the user's preferred language.
type string false false Has the value static value string false false A static (non-translatable) plain text content
An object containing a dynamic content placeholder, which returns pre-defined content that is translated to a user's preferred language. See Dynamic content article .