Surveys Version 1

Suggest Edits

The documentation present in this sheet refers to the table that contains survey information, such as title, questions, terms and conditions, among others.

This is a snapshot table.

IMPORTANT:

  • Please note that there are some [DEPRECATED] fields, you can safely ignore them, even though they will be present in the data exchange. Deprecated fields refer to fields that were collected in the past, and are either not available anymore or cannot be captured for any reason. They are still kept on the database for backwards compatibility reasons;
  • [EXPERIMENTAL] features are undergoing active development and their definition or collection method may change at any moment without prior notice. We ask not to rely on them for decision making and reporting
  • Field data collection is made on a best effort basis. Since there are many permisson and device configuration scenarios, it is not possible to guarantee full data collection.

surveyid

Type: STRING

Description

ID of the survey

Value Example

5ffda1b9f2c886003f0e176f

Possible Values (if category)

-

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

_class

Type: STRING

Description

Type of the survey. Internal purposes.

Value Example

com.iu.acadia.microservice.campaign.model.db.Survey

Possible Values (if category)

-

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

organizationid

Type: STRING

Description

Partner ID for Siprocal. Internal purposes.

Value Example

6364r60eg28a70050364bd2

Possible Values (if category)

-

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

title

Type: STRING

Description

Title of the survey

Value Example

Coffee Survey

Possible Values (if category)

-

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

description

Type: STRING

Description

Survey introduction for the end user

Value Example

We'd like to hear your opinion on X

Possible Values (if category)

-

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

status

Type: STRING

Description

Status of the survey

Value Example

ACTIVE

Possible Values (if category)

ACTIVE
ARCHIVED

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

questions

Type: STRING

Description

Stringfied JSON array of question objects. Please see "Question Fields" below for key descriptions.

Value Example

"[{'id': '6434af7d11d74c5124f3a262',
  'question': 'O que você mais gosta do app?',
  'answerType': 'CHECKBOX',
  'answerSubType': 'NONE',
  'answerOptions': ['Ponto de Onibus',
   'Linhas e horários de Onibus',
   'Recarga '],
  'randomize': True,
  'routeOptions': {'type': 'L', 'defaultTarget': '64adb16c64d32Fbce78c8357'}},
 {'id': '64adb16c634Gcfbce78c8357',
  'question': 'Qual o seu nível de satisfação no uso do app?',
  'answerType': 'DROPDOWN',
  'answerSubType': 'NONE',
  'answerOptions': ['Muito insatisfeito',
   'Insatisfeito',
   'Neutro',
   'Satisfeito',
   'Muito Satisfeito'],
  'randomize': False,
  'routeOptions': {'type': 'L', 'defaultTarget': 'SUBMIT'}}]"

Possible Values (if category)

-

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

Question Fields

id

Type: STRING

Description

Question ID

Value Example
5ffda1b9f2c886003f0e176f
Possible Values (if category)

question

Type: STRING

Description

Question Text/Title

Value Example
Do you like coffee?
Possible Values (if category)

answerType

Type: STRING

Description

Answer type

Value Example
CHECKBOX
Possible Values (if category)
  • CHECKBOX
  • DROPDOWN
  • FREETEXT
  • RADIOBUTTON
  • SLIDER

answerSubType

Type: STRING

Description

Detail for Answer Type

Value Example
RANGE_DECIMAL
Possible Values (if category)
  • RANGE_DECIMAL (SLIDER)
  • RANGE_INTEGER (SLIDER)

answerOptions

Type: ARRAY

Please note this field is within a JSON string, ARRAY is not an actual data type

Description

Alternatives for answers, when applicable

Value Example
["Yes","No"]
Possible Values (if category)

randomize

Type: BOOLEAN

Description

If alternatives are shown in random order

Value Example
true
Possible Values (if category)

routeOptions

Type: OBJECT

Please note this field is within a JSON string, OBJECT is not an actual data type

Description

  • type field define whether survey follows linear (""L"") flow or conditional (""C"") flow

  • defaultTarget field define next target question or end of survey

  • path field defines multiple options of question and their next target question

Value Example
{'type': 'L', 'defaultTarget': '64adb16c64d32Fbce78c8357'}
Possible Values (if category)

userid

Type: STRING

Description

User ID that created the campaign. Internal purposes.

Value Example

5a2950a0993c8f15435c25511

Possible Values (if category)

-

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

termsandconditions

Type: STRING

Description

Link for the survey's terms and conditions, if applied

Value Example

https://www.google.com

Possible Values (if category)

-

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

createdat

Type: BIGINT

Description

Date when the survey was created. Unix TImestamp in seconds format.

Value Example

1610457529

Possible Values (if category)

-

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

updatedat

Type: BIGINT

Description

Date when the survey was updated. Unix TImestamp in seconds format.

Value Example

1610457529

Possible Values (if category)

-

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

version

Type: STRING

Description

Version of the survey

Value Example

1.0

Possible Values (if category)

-

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

istest

Type: STRING

Description

If the survey is a test or not

Value Example

False

Possible Values (if category)

True
False

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

Updated 9 months ago