Skip to content

Get Survey Summary

GET
/feedback/surveys/{survey_id}/summary

Headline score, response rate and distribution for one survey.

Authorizations

Parameters

Path Parameters

survey_id
required

Survey id (UUID) — from GET /feedback/surveys

string

Survey id (UUID) — from GET /feedback/surveys

Query Parameters

bucket

Trend bucket: day, week or month.

string
default: week

Trend bucket: day, week or month.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
bucket
required
string
csat_avg
Any of:
number
delivery_channel
required
string
detractors
required
integer
dissatisfied
Any of:
integer
neutral
Any of:
integer
nps_score
Any of:
number
passives
required
integer
promoters
required
integer
response_rate
required
object
rate
required
number
responded
required
integer
sent
required
integer
satisfied
Any of:
integer
survey_id
required
string
time_series
required
Array<object>
object
csat_avg
Any of:
number
detractors
required
integer
nps_score
Any of:
number
passives
required
integer
period
required
string
promoters
required
integer
total
required
integer
total_respondents
required
integer
type
required
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string