Survey Response Data Object

Field Guide

The survey response data object contains information about the received survey response.

Name Type Example Notes
name String Happy An accessible name of a response value. Present only for the following survey types:
  • Faces (options: Happy, Neutral, Sad);
  • Thumbs up/down (options: Thumbs Up, Thumbs Down);
  • Emoji.
value String 😀 A customer's response to the survey:
  • for Faces survey, this will be one of [😀, 😐, 🙁];
  • for Thumbs up/down survey, this will be one of [👍, 👎];
  • for Emoji survey, this will be one of the emojis configured for the survey;
  • for Multiple Choice survey, this will be the chosen text option;
  • for NPS survey, this will be the value from the range 0-10, passed as a String;
  • for Text survey, this will value will not be present.
category String promoter Present only for NPS surveys. Options: promoter, passive, detractor.
comment String Optional customer's comment to the submitted response. Will be always present for Text surveys.
timestamp Datetime 2022-09-05T13:43:12Z UTC time when the survey response was submitted.

Examples

Faces survey

{
    "name": "Happy",
    "value": "😀",
    "comment": "Just awesome!",
    "timestamp": "2022-09-05T12:00:00Z"
}

Thumbs up/down survey

{
    "name": "Thumbs Up",
    "value": "👍",
    "comment": "Just awesome!",
    "timestamp": "2022-09-05T12:00:00Z"
}

Emoji survey

{
    "name": "Woman in Lotus Position",
    "value": "🧘🏼",
    "comment": "Feeling zen...",
    "timestamp": "2022-09-05T12:00:00Z"
}

Multiple Choice survey

{
    "value": "Yes",
    "comment": "I simply like it, that's why",
    "timestamp": "2022-09-05T12:00:00Z"
}

Text survey

{
    "comment": "Just awesome!",
    "timestamp": "2022-09-05T12:00:00Z"
}

NPS survey

{
    "value": "10",
    "category": "promoter",
    "comment": "I would pay for it even if it costed twice as much!",
    "timestamp": "2022-09-05T12:00:00Z"
}
↑Back to top
© Help Scout 2024