Get Survey Org Summary

GET

/feedback/org-summary

• Production
• QA

Org-wide NPS and CSAT: headline scores, response rates and per-survey rollups.

Authorizations

• BearerAuth

Parameters

Query Parameters

segment

Any of:

string

string

null

null

Restrict to one audience list id. Omit for all contacts.

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

string

null

null

Responses

200

Successful Response

object

data

required

object

bucket

required

string

in_app_csat_avg

Any of:

number

number

null

null

in_app_respondents

integer

org_csat

required

object

csat_avg

Any of:

number

number

null

null

total_respondents

required

integer

org_nps

required

object

detractors

required

integer

nps_score

Any of:

number

number

null

null

passives

required

integer

promoters

required

integer

total_respondents

required

integer

per_survey

required

Array<object>

object

audience_count

Any of:

integer

integer

null

null

audience_name

Any of:

string

string

null

null

audience_ref

Any of:

string

string

null

null

cadence_days

Any of:

integer

integer

null

null

cadence_kind

Any of:

string

string

null

null

cadence_label

Any of:

string

string

null

null

csat_avg

Any of:

number

number

null

null

delivery_channel

Any of:

string

string

null

null

detractors

required

integer

is_active

boolean

default: true

name

Any of:

string

string

null

null

nps_score

Any of:

number

number

null

null

passives

required

integer

promoters

required

integer

sent_count

integer

status

Any of:

string

string

null

null

survey_id

required

string

total_respondents

required

integer

trend

Array<object>

default:

object

csat_avg

Any of:

number

number

null

null

detractors

required

integer

nps_score

Any of:

number

number

null

null

passives

required

integer

period

required

string

promoters

required

integer

total

required

integer

type

required

string

segment

Any of:

string

string

null

null

time_series

required

Array<object>

object

csat_avg

Any of:

number

number

null

null

detractors

required

integer

nps_score

Any of:

number

number

null

null

passives

required

integer

period

required

string

promoters

required

integer

total

required

integer

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string