API reference / Surveys
Change a survey, show it or stop it
Changes the name, the questions, who gets the survey and how often. With active true, the survey shows in the product, and the survey that showed before stops. With active false, it stops. A survey with no question cannot show. Send only what changes. Owners and admins only.
/api/v1/surveys/{id}Other ways to call it
troopy surveys setPath parameters
id*stringA 24-character id
Body
application/jsonnamestringAt least 1 characters · At most 80 characters
scoredbooleanAsks how a customer would feel without the product, or leaves that question out
questionsarray<object>The open questions, whole and in order. It takes the place of the list that the survey has. A question keeps its answers while it keeps its id
At most 5 items
2 properties
idstringThe id of a question that the survey has now. Leave it out for a new question
text*stringAt least 5 characters · At most 200 characters
audienceenum<string>engagedeveryone
againinteger | nullAfter how many days a customer gets the survey again. Null: one time
activebooleantrue: the survey shows, in the place of the survey that showed. false: it stops
Response
200 · 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