Survey
A Survey is a Form sent to measure, such as NPS or CSAT, whose answers become Metrics and Evidence.
Properties
Inherited from Form: 1 property
| Property | Type | Required | Description |
|---|---|---|---|
fields | json | required | The fields and their types. |
Object
{
"$id": "https: //api.sb/ quietcopy.com/ surveys/ survey_1",
"$type": "Survey",
"fields": {}
}Relationships
- A Survey informs many Metrics: Survey answers compute Metrics, such as a satisfaction score.
informs, inverseinformedBy.
Verbs
createCreates a Survey.POST /{namespace}/surveysgetReturns one Survey by id.GET /{namespace}/surveys/{id}listReturns Surveys, newest first, one page at a time.GET /{namespace}/surveysupdateChanges the given properties of a Survey.PATCH /{namespace}/surveys/{id}deleteDeletes a Survey; its history is kept.DELETE /{namespace}/surveys/{id}
Permissions
Which Access level may call each Verb. One-way Verbs wait their delay window.
| Operation | owner | admin | member | viewer |
|---|---|---|---|---|
Survey.create | Yes | Yes | Yes | No |
Survey.get | Yes | Yes | Yes | Yes |
Survey.list | Yes | Yes | Yes | Yes |
Survey.update | Yes | Yes | Yes | No |
Survey.delete | Yes | Yes | Yes | No |
Call it
Add a survey to TutorLoop.Example
An NPS Survey goes to each Customer 30 days after signup. Scores feed the NPS Metric, and comments become Evidence.