API reference / Surveys
Make a survey
Makes a survey from a template, or as a copy of another survey. pmf asks how a customer would feel without the product, then three open questions, and comes again after 30 days. feedback asks what a customer likes, dislikes and wants built, one time. blank has no question. The new survey does not show: a change with active shows it. Owners and admins only. A workspace keeps 50 surveys.
/api/v1/surveysOther ways to call it
troopy surveys addIdempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Body
application/jsonnamestringThe name of the survey. Without it: the name of the template, or of the copy
At least 1 characters · At most 80 characters
templateenum<string>What the survey starts from. Without template and from: blank
pmffeedbackblank
fromstringAnother survey of the workspace: the new survey is a copy of its questions and its rules. It wins over template
Response
201 · application/jsondata*object14 properties
id*stringA 24-character id
name*stringThe name of the survey, for the people of the business. Customers never see it
active*booleanThe survey shows in the product now. One survey of a workspace shows at a time
scored*booleanThe survey asks how a customer would feel without the product. The score comes from this question, and its words are fixed
questions*array<object>The open questions, in the order that the survey asks them, after the question of the score. A customer can skip each one
2 properties
id*stringtext*stringThe question, in the words of the business
audience*enum<string>engaged: the users who know the product, 7 days after they began, with steady use or 3 days of use in the last 30. everyone: each user
engagedeveryone
again*integer | nullAfter how many days a customer gets the survey again. Null: a customer answers it one time
shown*integerThe customers who saw the survey
answered*integerThe customers who answered it
lastAnswerAt*string | nullWhen a customer last answered it
score*object | nullThe score of this survey, each customer with its latest answer to it. Null when it does not ask that question
8 properties
answers*integerThe answers that count: each answer but no_longer_use
very*integerWould be very disappointed without the product
somewhat*integerWould be somewhat disappointed
not*integerWould not be disappointed
gone*integerNo longer use the product. These are not in the score
love*number | nullThe share that would be very disappointed, in percent. Null under 5 answers
low*number | nullThe low end of the 95% range of that share, in percent. Null under 10 answers
level*enum<string>hidden: under 5 answers, so no share. directional: 5 to 9 answers. ranked: 10 or more
hiddendirectionalranked
by*objectWho made it
2 properties
type*stringname*string | nullactivatedAt*string | nullWhen the survey last began to show
createdAt*stringISO 8601 date and time