NPS-Net Promoter Score
Net Promoter Score®, or NPS®, measures customer experience and predicts business growth. This proven metric transformed the business world and now provides the core measurement for customer experience management programs the world round. This API allows rapidly implement one of the most well known and accepted KPI to measure customer satisfaction and loyalty. Create your survey templates and…
NPS-Net Promoter Score endpoints
| Method | Endpoint | Description |
|---|---|---|
| ORGANIZATION | ||
| PUT |
Create Organization /nps/organization/create |
Create an Organization. An unique organization id (oid) is automatically assigned, as well the date and time of creation. |
| DELETE |
Delete Organization /nps/organization/delete/{oid} |
Delete an organization by its organization id (oid). If a non existent oid is provided, none record is modified. |
| POST |
Update Organization /nps/organization/update/{oid} |
Update an Organization by its id (oid). If a non-existent organization id is provided, none operation is performed. Upsert is not enabled. |
| GET |
Read Organization /nps/organization/read/{oid} |
Get a organization record by its organization id (oid) |
| TEMPLATE | ||
| PUT |
Create NPS default template /nps/template/create/default |
Issue a new default NPS template, with 3 basic questions, being the first (q1) used to calculate NPS, the second a custom numeric value and the third an open question. |
| PUT |
Create NPS custom template /nps/template/create/custom |
Issue a new custom NPS template. A custom template basically allows you extend a layout of a default template, adding your own set of questions. You MUST kept at least the 3… |
| POST |
Update NPS default template /nps/template/update/default/{tid} |
Update a default NPS template, issuing a new set of questions and reference data. |
| POST |
Update NPS custom template /nps/template/update/custom/{tid} |
Update a custom NPS template, issuing a new set of questions and reference data. |
| GET |
Read NPS template /nps/template/read/{tid} |
Get details of a given template by its template id (tid) |
| GET |
List all NPS Organization templates /nps/template/list/organization/{oid} |
Get a list of all NPS templates of a given Organization by its organization id (oid) |
| DELETE |
Delete NPS template /nps/template/delete/{tid} |
Delete a given NPS template by its id (tid). NOTE: The surveys recorded previously using this template WILL NOT be deleted. |
| SURVEY | ||
| PUT |
Submit a default survey /nps/survey/default/{tid} |
Issue a customer survey answers object based on a default template of questions (identified by its respective template id - tid) |
| PUT |
Submit a custom survey /nps/survey/custom/{tid} |
Issue a customer survey answers object based on a custom template of questions (identified by its respective template id - tid). Custom NPS survey response MUST have at least the… |
| POST |
Submit default survey via url parameters /nps/survey/default/{tid} |
Issue a customer survey answers via URL Parameters, based on a default template of questions (identified by its respective template id - tid). This method allows you to post in… |
| PUT |
Submit a default survey with NLP /nps/survey/default/nlp/{tid} |
Issue a customer survey answers object based on a default template of questions (identified by its respective template id - tid), and automatically generates a word cloud for… |
| GET |
Read a survey /nps/survey/read/{sid} |
Get the details of a given customer survey by its survey id (sid) |
| GET |
Read all templates surveys /nps/survey/read/template/{tid} |
Get a list of all customer surveys answers related to a given template of questions (tid). In this method, you can see how each customer answered a given template of questions |
| REPORTING | ||
| GET |
Details all organization surveys /nps/report/surveys/organization/{oid} |
Get a full list of all customer survey responses for a given organization, by identifying its organization id (oid) |
| GET |
Details all templates answers /nps/report/surveys/template/{tid} |
Get a full list of all customer survey responses for a given template, by identifying its template id (tid) |
| GET |
NPS Organization /nps/report/organization/{oid} |
Get a summary of NPS calculation for a given organization. It considers the overall answers related to all templates belonging to a given organization and consolidates in a… |
| GET |
NPS Template /nps/report/template/{tid} |
Get a summary of NPS calculation for a given template. It considers the overall answers related to that template and consolidates in a global NPS indicator. A time period is… |
| GET |
NPS Client /nps/report/client/{cid} |
Get a summary of NPS calculation for a given client_id. It considers the overall answers related to all survey answers belonging to a given client and consolidates in a global… |
| ANALYSIS | ||
| GET |
Read a survey NLP /nps/survey/read/nlp/{sid} |
Get a detail of customer survey answer by its survey id (sid), and applies to the third answer (a3) the sentiment analysis feature. |
NPS-Net Promoter Score pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
| PRO | $17 / month | 20 / minute |
|
| ULTRA | $63 / month | 50 / minute |
|
| MEGA | $287 / month | 1 / second |
|