Docs

Surveys

One question, to the right people, at the right moment, inside your app.

Types#

• NPS: 0 to 10. The score is the share of promoters (9 and 10) minus the share of detractors (0 to 6), from -100 to 100.
• Rating: 1 to 5.
• Multiple choice: two to six answers.
• Open question: free text.

NPS, rating and choice can have a follow-up question, such as “What is the main reason for your score?”. The form shows a live preview of the card exactly as the widget draws it.

Who sees it#

The widget on your site shows the survey; there is nothing else to install. To aim it at a group, sign your customers in with a user token that carries the attributes, then enter the group as key:value:

plan:pro        // customers whose token says plan "pro"
beta:true       // an attribute you send yourself
company:Acme

Aiming at a group needs a token, which is part of Pro. Without a group the survey is shown to every visitor with the widget. You can also limit it to pages: /dashboard is one page, /settings/* is that section.

Timing and repeats#

• Wait: seconds after the page loads before the card appears.
• Ask again after: days before the same person can be asked again. 0 means each person is asked once, ever. The check runs on the server, so clearing the browser does not bring it back for a signed-in customer.
• Stop on: an end date.
• Someone who closes the card is left alone for a week.

Results#

The survey page shows the headline number, how answers spread, results split by plan, week by week change and every comment with its score. Export CSV downloads every answer with the plan, company, page and, for signed-in customers, the email.

Webhook#

Each answer fires a signed survey.response event; see Webhooks. Send it to Slack, your CRM or a spreadsheet.

{ "type": "survey.response", "data": {
  "survey": { "id": "sv_4k1", "name": "Quarterly NPS", "kind": "nps" },
  "score": 9, "comment": "Love the keyboard shortcuts.", "plan": "Pro", "company": "Acme"
} }

Limits and privacy#

Free runs 1 survey at a time, Pro 10 and Team 50. Drafts and answers are not limited. An anonymous visitor is a random id made by their own browser; an email is stored only for a customer your app signed in, and is removed when you erase that person under Data & privacy.