Skip to main content
GET
Get NPS summary

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

surveyId
string<uuid>

One NPS campaign

companyId
string<uuid>
periodType
enum<string>
Available options:
daily,
weekly,
monthly,
quarterly,
yearly,
all_time
dateFrom
string<date>

Earliest period start

dateTo
string<date>

Latest period end

Response

Analytics rows, newest first

data
object[]
required
truncated
boolean
required

true when the newest 200 periods were returned and older ones exist; narrow the filters