Skip to content

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
PropertyTypeRequiredDescription
fieldsjsonrequiredThe fields and their types.

Object

JSON
{
  "$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, inverse informedBy.

Verbs

  1. createCreates a Survey.
    POST /{namespace}/surveysdoSurvey.created
  2. getReturns one Survey by id.
    GET /{namespace}/surveys/{id}readNo Event
  3. listReturns Surveys, newest first, one page at a time.
    GET /{namespace}/surveysreadNo Event
  4. updateChanges the given properties of a Survey.
    PATCH /{namespace}/surveys/{id}doSurvey.updated
  5. deleteDeletes a Survey; its history is kept.
    DELETE /{namespace}/surveys/{id}doSurvey.deleted

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Survey.createYesYesYesNo
Survey.getYesYesYesYes
Survey.listYesYesYesYes
Survey.updateYesYesYesNo
Survey.deleteYesYesYesNo

Call it

Text
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.