Skip to main content
GET
/
reports
/
nps-tool
/
{npsToolId}
Get NPS tool report
curl --request GET \
  --url https://clientapi.woku.app/reports/nps-tool/{npsToolId} \
  --header 'Authorization: Bearer <token>'
{
  "npsToolId": "507f1f77bcf86cd799439021",
  "name": "Post-Purchase Survey",
  "npsScore": 55,
  "totalResponses": 120,
  "promoters": {
    "count": 75,
    "percentage": 62.5
  },
  "passives": {
    "count": 30,
    "percentage": 25
  },
  "detractors": {
    "count": 15,
    "percentage": 12.5
  },
  "scoreDistribution": {},
  "recentResponses": [
    {
      "score": 5,
      "comment": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Company API key. Obtain this from your Woku dashboard under Settings > API Keys.

Path Parameters

​
npsToolId
string<objectid>
required

MongoDB ObjectId of the NPS tool

Example:

"507f1f77bcf86cd799439011"

Response

NPS tool report retrieved successfully

​
npsToolId
string<objectid>

NPS tool identifier

Example:

"507f1f77bcf86cd799439021"

​
name
string

NPS tool name

Example:

"Post-Purchase Survey"

​
npsScore
number

Net Promoter Score for this tool (-100 to 100)

Example:

55

​
totalResponses
integer

Total number of responses for this tool

Example:

120

​
promoters
object
​
passives
object
​
detractors
object
​
scoreDistribution
object

Distribution of scores from 0-10

​
recentResponses
object[]

Recent NPS responses