REST API: NPS Responses
Last updated
Last updated
Replace {subdomain}
in the endpoints below with your Vitally subdomain.
You can find your subdomain in the URL used to log into Vitally (i.e., https://yoursubdomain.vitally.io
GET
US Data Center (default):
EU Data Center:
Paginated list of NPS Responses, by default ordered by updatedAt
.
Query Params (see Pagination)
Example Request
Example Response
GET
US Data Center (default):
EU Data Center:
Paginated list of NPS Responses for a given Account, by default ordered by updatedAt
.
Request Params
Query Params (see Pagination)
Example Request
Example Response
POST
US Data Center (default):
EU Data Center:
NPS Response's are unique on externalId
. So creating and updating are both possible via the POST endpoint.
Request Body
Example Request
Example Response
GET
US Data Center (default):
EU Data Center:
Request Params
PUT
US Data Center (default):
EU Data Center:
Request Params
Request Body
DELETE
US Data Center (default):
EU Data Center:
Request Params
Property
Description
Editable
id
Vitally's unique ID for the NPS Response
No
createdAt
Datetime the NPS Response was created
No
updatedAt
Datetime the NPS Response was last updated
No
externalId
Your unique ID for the NPS Response
Only on create
userId
Required The ID of the Vitally User the NPS Response is from
Yes
score
Required The numerical score (0-10)
Yes
feedback
The text feedback submitted with the response
Yes
respondedAt
The date-time the user submitted the response
Yes
Property
Type
Description
accountId
string
The Account ID assigned by Vitally
Param
Type
Description
limit
number
(optional) The number of items to return. The max/default is 100
from
string
(optional) The cursor returned from a previous request
Property
Type
Description
userId
string
Required The Vitally assigned ID of the Vitally User to associate the NPS Response with. This is NOT the external ID you assign for the user, but the ID that Vitally assigns.
respondedAt
string
Required The timestamp of when the NPS Response was submitted
score
number
Required The score of the NPS Response
externalId
string
The unique ID of the NPS Response in your system
feedback
string
The text feedback the User submitted
Property
Type
Description
id
string
The NPS Response ID assigned by Vitally
Property
Type
Description
id
string
Accepts both the NPS Repsonse ID assigned by Vitally and the externalId
if provided when creating the NPS Response
Property
Type
Description
userId
string
Required The Vitally assigned ID of the Vitally User to associate the NPS Response with
respondedAt
string
Required The timestamp of when the NPS Response was submitted
score
number
Required The score of the NPS Response
feedback
string
The text feedback the User submitted
Property
Type
Description
id
string
The NPS Response ID assigned by Vitally