NPS API documentation

Test the API easily using Postman.


Get dashboard information

URL: [GET] https://app.userforever.com/api/nps/get/

Query parameters

Field Type Details
token text Search token Required

Response fields

Field Details
status True if NPS exists or false if none
id NPS Id
question The question to be displayed
comment_status Whether the comment field should be displayed
comment_required If filling in the comment field is required
comment_text Titulo do campo de comentario
comment_require_text Text stating that the comment field is required
thanks_status If the thank you message that should be displayed
thanks_text Thank you text

Submit evaluation note to API

URL: [GET] https://app.userforever.com/api/nps/vote/

Query parameters

Field type Details
id int NPS survey id Required
vote int Research note that can be from 0 to 10 Required
comment text Additional feedback comment Optional
identifier text User identifier such as email, name, id or other data. Optional
campaign text Search campaign name Optional
channel text Channel where the survey was conducted (website, email, link) Optional
tags text Tags to identify campaigns. Include more than one separating with a comma Optional

Response fields

Field Details
status True if it worked or False if an error occurred

UserForever 2021 - Powered by @evandro_zanatta