Surveys Tools
View customer satisfaction surveys, access NPS analytics, and track score trends over time.
Required scope: surveys:read
All survey tools are read-only.
Tools Overview
| Tool | Description | Read-only? |
|---|---|---|
list_surveys | List customer satisfaction surveys | Yes |
get_survey_analytics | Get NPS score, response rate, and analytics | Yes |
get_nps_trend | Get NPS score trend over recent months | Yes |
list_surveys
List customer satisfaction surveys.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
search | string | No | Search by survey name |
get_survey_analytics
Get NPS score, response rate, and analytics for a survey.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
survey_id | integer | Yes | The survey ID |
get_nps_trend
Get NPS score trend over recent months for a survey.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
survey_id | integer | Yes | The survey ID |
months | integer | No | Number of months to show (default 6) |
create_survey
Create a new customer survey. The user can add questions and publish it later via the survey builder.
Required scope: surveys:write
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Survey name |
description | string | No | Short summary |
send_trigger | string | No | manual (default), after_booking_complete, after_return, after_checkout |
Returns
{
"success": true,
"message": "Survey 'Post-rental NPS' created.",
"survey": { "id": 12, "name": "Post-rental NPS", "unique_code": "abc123def456" }
}
Related
- Surveys REST API - REST API endpoints for surveys