This endpoint is used for fetching basic survey data and NPS scores.

{
  "date_shortcut": "all_time"
}

Response attributes

AttributeTypeDescription
surveyobjectSurvey information data.
survey.titlestringSurvey title.
survey.statusstringSurvey status. One of: draft, active
survey.response_ratestringSurvey response rate.
survey.public_hash_idstringSurvey public hash id used to identify survey.
survey.promotersobjectSummary data about promoters from survey answers.
survey.promoters.percentagenumberPercentage of answers that were promoters.
survey.promoters.deltanumberPromoters delta - describing the +/- change for the similar period we measure against.
survey.passivesobjectSummary data about passives from survey answers.
survey.passives.percentagenumberPercentage of answers that were passives.
survey.passives.deltanumberPassives delta - describing the +/- change for the similar period we measure against.
survey.number_of_responsesnumberNumber of answers.
survey.npsobjectSummary data about NPS from survey answers.
survey.nps.percentagenumberThe NPS score.
survey.nps.deltanumberNPS delta - describing the +/- change for the similar period we measure against.
survey.inserted_atdateSurvey creation date.
survey.detractorsobjectSummary data about detractors from survey answers.
survey.detractors.percentagenumberPercentage of answers that were detractors.
survey.detractors.deltanumberDetractors delta - describing the +/- change for the similar period we measure against.
survey.additional_questionsobjectAdditional questions.
survey.additional_questions.optionsarrayList of options to select if type of the question is single_select or multi_select.
survey.additional_questions.positionnumberPosition of the additional question.
survey.additional_questions.public_hash_idstringAdditional question public hash id used to identify.
survey.additional_questions.questionstringContent of the additional question.
survey.additional_questions.typestringAdditional question type. One of: single_select, multi_select, free, scale.
Language
Click Try It! to start a request and see the response here!