Get Summary of Survey Groups

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
{
  "date_shortcut": "all_time"
}

Response attributes

AttributeTypeDescription
survey_groupobjectSurvey group information data.
survey_group.namestringSurvey group title.
survey_group.public_hash_idstringSurvey group public hash id used to identify survey group.
survey_group.promotersobjectSummary data about promoters from survey group answers.
survey.promoters.percentagenumberPercentage of answers that were promoters.
survey_group.promoters.deltanumberPromoters delta - describing the +/- change for the similar period we measure against.
survey_group.passivesobjectSummary data about passives from survey group answers.
survey_group.passives.percentagenumberPercentage of answers that were passives.
survey_group.passives.deltanumberPassives delta - describing the +/- change for the similar period we measure against.
survey_group.number_of_responsesnumberNumber of answers.
survey_group.npsobjectSummary data about NPS from survey group answers.
survey_group.nps.percentagenumberThe NPS score.
survey_group.nps.deltanumberNPS delta - describing the +/- change for the similar period we measure against.
survey_group.inserted_atdateSurvey group creation date.
survey_group.detractorsobjectSummary data about detractors from survey group answers.
survey_group.detractors.percentagenumberPercentage of answers that were detractors.
survey_group.detractors.deltanumberDetractors delta - describing the +/- change for the similar period we measure against.
survey_group.surveysobjectSurveys information data.
survey_groups.surveys.titlestringSurvey title.
survey_groups.surveys.statusstringSurvey status. One of: draft, active.
survey_groups.surveys.public_hash_idstringSurvey public hash id used to identify survey.
survey_groups.surveys.inserted_atdateSurvey creation date.
Path Params
string
required

Unique ID of a survey

Query Params
string
Defaults to all_time

Date range for which we want to fetch answers. Allowed values: today, yesterday, last_week, last_month, last_7_days, last_30_days, all_time, custom

date

Parameter required when date_shortcut is set to custom. Filters answers only received after specific datetime. Format: 2021-10-24T03:30:30Z or 2021-10-24

date

Parameter required when date_shortcut is set to custom. Filters answers only received before specific datetime. Format: 2021-10-24T03:30:30Z or 2021-10-24

Headers
string
required
Defaults to Bearer <token>
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json