Skip to main content
GET
Get NPS analytics

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Survey ID

Query Parameters

periodType
enum<string>

Filter by period type

Available options:
daily,
weekly,
monthly,
quarterly,
yearly,
all_time
companyId
string<uuid>

Filter by company ID

dateFrom
string<date-time>

Filter by period start date (from)

dateTo
string<date-time>

Filter by period end date (to)

live
boolean | null
default:false

Calculate live analytics instead of using stored data

Response

NPS analytics data

data
object
required