Skip to content

Get Company Survey Nps

GET
/feedback/companies/{company_id}/nps

Account-level NPS: score, promoter/detractor split, coverage and per-contact rows.

The headline score is suppressed (null) below the minimum-respondent threshold rather than published from a handful of answers. Contacts the calling key cannot see are excluded from every figure, so the coverage denominator matches the rows returned.

Authorizations

Parameters

Path Parameters

company_id
required

Company id (mashup_companies.id)

integer

Company id (mashup_companies.id)

Query Parameters

bucket

Trend bucket: day, week or month.

string
default: week

Trend bucket: day, week or month.

survey_id
Any of:
string

Restrict to one survey. Omit to combine every NPS survey.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
bucket
required
string
company_id
required
integer
contacts
required
Array<object>
object
classification
Any of:
string
contact_id
required
integer
first_name
Any of:
string
history
Array<object>
default:
object
responded_at
Any of:
string
score
required
integer
send_id
Any of:
integer
last_name
Any of:
string
last_responded_at
Any of:
string
responded
boolean
score
Any of:
integer
trend
Any of:
string
coverage
required
object
rate
required
number
responded
required
integer
total_contacts
required
integer
detractors
required
integer
nps_score
Any of:
number
passives
required
integer
promoters
required
integer
suppressed
required
boolean
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
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