{
  "date_shortcut": "all_time"
}

Response attributes

Attribute	Type	Description
survey	object	Survey information data.
survey.title	string	Survey title.
surveys.question	string	Survey question.
survey.status	string	Survey status. One of: `draft`, `active`
surveys.channel_type	string	Survey type. One of: `email`, `email_embed`, `link`, `website_overlay`, `website_embed`
survey.response_rate	string	Survey response rate.
survey.public_hash_id	string	Survey public hash id used to identify survey.
survey.promoters	object	Summary data about promoters from survey answers.
survey.promoters.percentage	number	Percentage of answers that were promoters.
survey.promoters.delta	number	Promoters delta - describing the +/- change for the similar period we measure against.
survey.passives	object	Summary data about passives from survey answers.
survey.passives.percentage	number	Percentage of answers that were passives.
survey.passives.delta	number	Passives delta - describing the +/- change for the similar period we measure against.
survey.number_of_responses	number	Number of answers.
survey.nps	object	Summary data about NPS from survey answers.
survey.nps.percentage	number	The NPS score.
survey.nps.delta	number	NPS delta - describing the +/- change for the similar period we measure against.
survey.inserted_at	date	Survey creation date.
survey.detractors	object	Summary data about detractors from survey answers.
survey.detractors.percentage	number	Percentage of answers that were detractors.
survey.detractors.delta	number	Detractors delta - describing the +/- change for the similar period we measure against.