Surveys API
The Surveys API provides access to customer satisfaction surveys, NPS (Net Promoter Score) tracking, and feedback collection. Surveys are separate from waivers and forms, focusing specifically on post-experience feedback.
What are Surveys?โ
Surveys in EquipDash are used to collect customer feedback after bookings or experiences. They support various rating types including:
| Rating Type | Description | Scale |
|---|---|---|
| NPS Rating | Net Promoter Score | 0-10 |
| Star Rating | Simple satisfaction | 1-5 |
| CSAT | Customer Satisfaction Score | 1-5 |
| CES | Customer Effort Score | 1-7 |
| Likert Scale | Agreement scale | 1-5 |
Survey Structureโ
Survey
โโโ Basic Info (name, status, unique_code)
โโโ Fields[] (question definitions)
โ โโโ NPS Rating
โ โโโ Star Rating
โ โโโ Text feedback
โ โโโ Multiple choice
โ โโโ Other field types
โโโ AssignedProducts[] (which products trigger this survey)
โโโ AssignedExperiences[] (which experiences trigger this survey)
โโโ Responses[] (submitted responses with analytics)
NPS Categoriesโ
When a survey contains an NPS rating field, responses are automatically categorized:
| Category | Score Range | Description |
|---|---|---|
| Promoter | 9-10 | Loyal enthusiasts who will refer others |
| Passive | 7-8 | Satisfied but unenthusiastic customers |
| Detractor | 0-6 | Unhappy customers who may damage your brand |
NPS Score = % Promoters - % Detractors (ranges from -100 to +100)
API Endpointsโ
| Method | Endpoint | Description | Scope Required |
|---|---|---|---|
GET | /v1/surveys | List all surveys | surveys:read |
GET | /v1/surveys/{id} | Get a single survey with fields | surveys:read |
POST | /v1/surveys/{id}/responses | Submit a survey response | surveys:write |
GET | /v1/surveys/{id}/responses | List responses for a survey | surveys:read |
GET | /v1/surveys/{id}/responses/{responseId} | Get a single response | surveys:read |
GET | /v1/surveys/{id}/analytics | Get survey analytics and NPS data | surveys:read |
Common Use Casesโ
Collecting Post-Booking Feedbackโ
Send a survey link after a booking is completed:
# Get active surveys for a product
curl "https://app.equipdash.com/api/v1/surveys?status=published" \
-H "Authorization: Bearer YOUR_API_KEY"
Tracking NPS Over Timeโ
Analyze customer sentiment with the analytics endpoint:
curl "https://app.equipdash.com/api/v1/surveys/123/analytics?date_from=2026-01-01&date_to=2026-01-31" \
-H "Authorization: Bearer YOUR_API_KEY"
Integrating with Customer Feedback Toolsโ
Export survey responses for analysis in external tools:
curl "https://app.equipdash.com/api/v1/surveys/123/responses?per_page=100" \
-H "Authorization: Bearer YOUR_API_KEY"
Related Resourcesโ
- Waivers & Forms - For legal waivers and data collection forms
- Customers - Customer records linked to survey responses
- Bookings - Survey responses can be linked to bookings
- Webhooks -
survey_response.submittedevent