Feedbackly
v.5.0.2
v.5.0.2
  • Getting started
  • REST API
    • Authentication
    • Responses
      • GET Responses
      • GET Response by id
    • Response chains
      • GET Response-chains
      • GET Response-chain by id
    • Questions
      • GET Questions
      • GET Question by id
    • Surveys
      • GET Surveys
      • GET Surveys by id
    • Touchpoints
      • GET Touchpoints
      • GET Touchpoint by id
    • Notes
      • Entity relationships
      • Pagination
      • Question types
  • Website widgets
    • Getting started
    • Attaching custom metadata to responses
    • Triggering surveys via custom properties
    • Debugging website widgets
Powered by GitBook
On this page
  1. REST API

Surveys

Survey data object

Field

Type

Example

Description

teamId

string

"5a3386af952bf6000177bdda"

Team id

languages

string[]

["en", "es"]

List of available languages for the survey

name

string

"Satisfaction survey"

Survey name

_id

string

"5a3386af952bf6000177bdda"

Survey id

language

string

"en"

Language used to display titles, choices etc

teamName

string

"My team name"

Team name

createdBy

string

"Khal Drogo"

User name

archived

boolean

false

Whether the survey is archived

questions

array

Questions embedded within the survey

> _id

string

"5a3386af952bf6000177bdda"

Question id

> questionType

string

"NPS"

> title

string

"How would you recommend us to a friend or colleague?"

Question title

> choices

array

Question choices

>> fieldId

string

"1"

The id of the field

>> fieldName

string

"Beef"

The label of the choice

>> type?

string

"string"

Type of field (Contact question type)

>> subType?

string

"tel"

Subtype of the field (Contact question type)

>> imageUrl?

string

"https://example.com/1.png"

Image url of the choice (Image question type)

PreviousGET Question by idNextGET Surveys

Last updated 4 years ago

See Question types