Skip to main content

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 TypeDescriptionScale
NPS RatingNet Promoter Score0-10
Star RatingSimple satisfaction1-5
CSATCustomer Satisfaction Score1-5
CESCustomer Effort Score1-7
Likert ScaleAgreement scale1-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:

CategoryScore RangeDescription
Promoter9-10Loyal enthusiasts who will refer others
Passive7-8Satisfied but unenthusiastic customers
Detractor0-6Unhappy customers who may damage your brand

NPS Score = % Promoters - % Detractors (ranges from -100 to +100)

API Endpointsโ€‹

MethodEndpointDescriptionScope Required
GET/v1/surveysList all surveyssurveys:read
GET/v1/surveys/{id}Get a single survey with fieldssurveys:read
POST/v1/surveys/{id}/responsesSubmit a survey responsesurveys:write
GET/v1/surveys/{id}/responsesList responses for a surveysurveys:read
GET/v1/surveys/{id}/responses/{responseId}Get a single responsesurveys:read
GET/v1/surveys/{id}/analyticsGet survey analytics and NPS datasurveys: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"
  • 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.submitted event