Get Summary of Survey

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
surveyobjectSurvey information data.
survey.titlestringSurvey title.
surveys.questionstringSurvey question.
survey.statusstringSurvey status. One of: draft, active
surveys.channel_typestringSurvey type. One of: email, email_embed, link, website_overlay, website_embed
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.
Path Params
string
required

Unique ID of a survey

Query Params
string
Defaults to plugin.key

Concatenation of the plugin identifier and a unique user key.

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

Responses

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