Skip to main content
GET
/
api
/
public
/
v1
/
surveys
/
nps
/
{id}
Get NPS survey
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/surveys/nps/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "title": "<string>",
    "description": "<string>",
    "questionText": "<string>",
    "frequencyInterval": 123,
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "isActive": true,
    "reminderEnabled": true,
    "reminderDaysAfter": 123,
    "followUpEnabled": true,
    "thankYouMessage": "<string>",
    "responseCount": 123,
    "inviteCount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "npsScore": 123,
    "averageScore": 123,
    "responseRate": 123,
    "promotersCount": 123,
    "passivesCount": 123,
    "detractorsCount": 123
  }
}

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

Response

NPS survey details with stats

​
data
object
required