Skip to main content

Extra data

Lisa Wong
Updated

Extra data is any data that cannot be mapped to a column or record. The fields in the extra data will vary depending on the concept.

Note: Extra data fields are useful when cross-referencing data with a survey in the application; however, we do not recommend creating complex scripts based on these fields as they may change.

Community surveys

Field Description
createdAt The timestamp value for the date the dataset was created.
id The ID for the survey in the dataset.
lastUpdatedAt The timestamp value for the date the survey was modified last.
name The string name for the survey as it appears in the application.
state The string value for the current status of the survey (Alive|Deleted|Hidden).
Note: Not all concepts have a state field.
version The current version number for the survey.

Community question

Field Description
choices Describes the answer options in choice questions (if applicable).
  • id: The column ID for the answer option in the dataset.
  • state: The string value for the current status of the answer in a choice question (Alive|Deleted|Hidden)
  • answerType: Identifies the answer option as a choice (regularAnswer) or open end (textAnswer)
  • text: The answer text.
extensionType The string name for the question type used in the survey (for example, numericSlider).
Note: This field does not provide context to the concept. When analyzing your data, use the dataTypes endpoint instead.
id The ID for the question in the dataset.
name The string name for the question as it appears in the application.
state The string value for the current status of the question (Alive|Deleted|Hidden).
Note: Not all concepts have a state field.
text The string value for the question text.
questionType The string name for the question type. For a complete list of possible question types in the application, see Questions.
Note: Datasets resources do not support Highlighter, Image Upload, and System questions at this time.

Community choice question with Other/Specify

Field Description
answerType The string value for the answer option.
  • regularAnswer: Choice option
  • textAnswer: Open end text box (for example, Other/Specify)
id The ID for the choice answer in the dataset.
state The string value for the current status of the answer (Alive|Deleted|Hidden).
Note: Not all concepts have a state field.
text The answer text.

Community grid question

Field Description
choices Describes the answer options in choice questions.
  • id: The grid column ID for the answer option.
  • state: The string value for the current status of the answer in a choice question (Alive|Deleted|Hidden)
  • text: The column text as it appears to members.
extensionType The string name for the question type used in the survey (for example, numericSlider).
Note: This field does not provide context to the concept. When analyzing your data, use the dataTypes endpoint instead.
gridType The string name for the grid question type (for example, SingleChoiceGrid).
id The ID for the column in the dataset.
name The string name for the question as it appears in the application.
state The string value for the current status of the survey (for example, Alive, Deleted, or Hidden).
Note: Not all concepts have a state field.
text The string value for the question text as it appears to members.

Community grid row

Field Description
id The ID for the grid row.
state The string value for the current status of the row (Alive|Deleted|Hidden).
Note: Not all concepts have a state field.
text The grid row text as it appears to members.

Community respondent variable

Respondent variables (formerly known as response variables) are data collected about a member at the time they participated in the survey; however, the data is not associated to a survey question.

Field Description
choices Describes the answer options in the respondent variable.
  • id: The choice ID in the dataset.
  • text: The respondent variable label.
id The respondent variable ID in the dataset.
name The string name for the respondent variable (for example, CompletionDate).

Sparq 1 surveys

Field Description
createdAt The timestamp value for the date the dataset was created.
id The GUID for the survey ID.
lastUpdatedAt The timestamp value for the date the survey was modified last.
name The string name for the survey as it appears in the application.
state The string value for the current status of the survey (Alive|Deleted|Hidden).
Note: Not all concepts have a state field.
version The current version number for the survey.

Sparq 1 questions

Field Description
choices Describes the answer options in choice questions (if applicable).
  • id: The column ID for the answer option in the dataset.
  • state: The string value for the current status of the anser in a choice question (Alive|Deleted|Hidden)
  • answerType: Identifies the answer option as a choice (regularAnswer) or open end (textAnswer )
  • Text: The answer text.
  • scaleValue: The numeric value for a question response that is used in statistical calculations. For more information, see Scale values.
  • precode: The value assigned to an answer for reporting.
extensionType The string name for the question type used in the survey (for example, numeric slider).
Note: This field does not provide context to the concept. When analyzing your data, use the dataTypes endpoint instead.
id The GUID for the concept in the dataset.
name The string name for the question as it appears in the application.
state The string value for the current status of the survey (for example, Alive or Deleted).
Note: Not all concepts have a state field.
text The string value for the question text.
questionType The string name for the question type. For a complete list of possible question types in the application, see Questions.

Sparq 1 choice with Other-Specify

Field Description
answerType The string value for the answer option.
  • regularAnswer: Choice option
  • textAnswer: Open end text box (for example, Other/Specify)
id The choice ID for the answer option.
precode The value assigned to an answer for reporting.
scaleValue The numeric value for a question response that is used in statistical calculations. For more information, see Scale values.
state The string value for the current status of the answer (Alive|Deleted|Hidden).
text The answer text.

Sparq 1 grid question

Field Description
choices Describes the answer options in choice questions.
  • id: The grid column ID for the answer option in the dataset.
  • state: The string value for the current status of the anser in a choice question (Alive|Deleted| Hidden).
  • text: The column text.
  • scaleValue: The numeric value for a question response that is used in statistical calculations. For more information, see Scale values.
  • Precode: The numeric value for an edited scale value.
extensionType The string name for the question type used in the survey (for example, numeric slider).
Note: This field does not provide context to the concept. When analyzing your data, use the dataTypes endpoint instead.
gridType The string name for the grid question type (for example, singleChoiceGrid).
id The column ID for the concept.
name The string name for the question as it appears in the application.
state The string value for the current status of the survey (Alive|Deleted|Hidden).
Note: Not all concepts have a state field.
text The string value for the question text.

Sparq 1 grid row

Field Description
id The grid row ID for the answer option.
state The string value for the current status of the grid row (Alive|Deleted|Hidden).
Note: Not all concepts have a state field.
text The grid row text.
Parent topic: Datasets

Related articles

Powered by Zendesk