afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/SurveyResponse.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "associated_objects",
    "field_reference"
  ],
  "title": "SurveyResponse - Data API",
  "description": "Represents information about a participant’s response to a survey, such as the status of the response, the participant’s location, and when the survey was completed.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "CompletionDateTime": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The date and time that the participant completed the survey."
    },
    "DataMapperExecutionStatus": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Status of all the survey data maps after a response is received. This field is available in API v49.0 and later, with Feedback Management - Starter and Feedback Management - Growth licenses. Possible values are: Pending InProgress Success Error"
    },
    "InterviewGuid": {
      "type": "string",
      "properties": "Filter, Group, idLookup, Nillable",
      "description": "An automatically-generated, unique ID for a saved survey response."
    },
    "InterviewId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the FlowInterview object that’s associated with this response."
    },
    "InvitationId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "The ID of the SurveyInvitation object that’s associated with this response."
    },
    "IpAddress": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The IP address of the device the participant used to take the survey."
    },
    "Language": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The language that the participant used to complete the survey. Possible values are: af—Afrikaans ar—Arabic ar_AE—Arabic (United Arab Emirates) ar_BH—Arabic (Bahrain) ar_DZ—Arabic (Algeria) ar_EG—Arabic (Egypt) ar_IQ—Arabic (Iraq) ar_JO—Arabic (Jordan) ar_KW—Arabic (Kuwait) ar_LB—Arabic (Lebanon) ar_LY—Arabic (Libya) ar_MA—Arabic (Morocco) ar_OM—Arabic (Oman) ar_QA—Arabic (Qatar) ar_SA—Arabic (Saudi Arabia) ar_SD—Arabic (Sudan) ar_SY—Arabic (Syria) ar_TN—Arabic (Tunisia) ar_YE—Arabic (Yemen) bg—Bulgarian bn—Bengali bs—Bosnian ca—Catalan cs—Czech cy—Welsh da—Danish de—German de_AT—German (Austria) de_BE—German (Belgium) de_CH—German (Switzerland) de_LU—German (Luxembourg) el—Greek en_AU—English (Australian) en_CA—English (Canadian) en_GB—English (UK) en_HK—English (Hong Kong) en_IE—English (Ireland) en_IN—English (Indian) en_MY—English (Malaysian) en_NZ—English (New Zealand) en_PH—English (Philippines) en_SG—English (Singapore) en_US—English en_ZA—English (South Africa) es—Spanish es_AR—Spanish (Argentina) es_BO—Spanish (Bolivia) es_CL—Spanish (Chile) es_CO—Spanish (Colombia) es_CR—Spanish (Costa Rica) es_DO—Spanish (Dominican Republic) es_EC—Spanish (Ecuador) es_GT—Spanish (Guatemala) es_HN—Spanish (Honduras) es_MX—Spanish (Mexico) es_NI—Spanish (Nicaragua) es_PA—Spanish (Panama) es_PE—Spanish (Peru) es_PR—Spanish (Puerto Rico) es_PY—Spanish (Paraguay) es_SV—Spanish (El Salvador) es_US—Spanish (United States) es_UY—Spanish (Uruguay) es_VE—Spanish (Venezuela) et—Estonian eu—Basque fa—Farsi fi—Finnish fr—French fr_BE—French (Belgium) fr_CA—French (Canadian) fr_CH—French (Switzerland) fr_LU—French (Luxembourg) ga—Irish gu—Gujarati hi—Hindi hr—Croatian hu—Hungarian hy—Armenian in—Indonesian is—Icelandic it—Italian it_CH—Italian (Switzerland) iw—Hebrew ja—Japanese ka—Georgian kn—Kannada ko—Korean lb—Luxembourgish lt—Lithuanian lv—Latvian mi—Te reo mk—Macedonian ml—Malayalam mr—Marathi ms—Malay mt—Maltese my—Burmese nl_BE—Dutch (Belgium) nl_NL—Dutch no—Norwegian pl—Polish pt_BR—Portuguese (Brazil) pt_PT—Portuguese (European) rm—Romansh ro—Romanian ro_MD—Romanian (Moldova) ru—Russian sh—Serbian (Latin) sh_ME—Montenegrin sk—Slovak sl—Slovene sq—Albanian sr—Serbian (Cyrillic) sv—Swedish sw—Swahili ta—Tamil te—Telugu th—Thai tl—Tagalog tr—Turkish uk—Ukrainian ur—Urdu vi—Vietnamese xh—Xhosa zh_CN—Chinese (Simplified) zh_HK—Chinese (Hong Kong) zh_SG—Chinese (Singapore) zh_TW—Chinese (Traditional) zu—Zulu"
    },
    "LastReferencedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The date and time that another Salesforce object last referenced this SurveyResponse object."
    },
    "LastViewedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The date and time that someone last viewed this SurveyResponse object."
    },
    "Latitude": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The latitude of the participant’s location."
    },
    "Location": {
      "type": "location",
      "properties": "Nillable",
      "description": "The latitude and longitude coordinates of the participant’s location."
    },
    "Longitude": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The longitude of the participant’s location."
    },
    "Name": {
      "type": "string",
      "properties": "Filter, Group, idLookup, Sort",
      "description": "The name of the participant."
    },
    "Status": {
      "type": "picklist",
      "properties": "Filter, Group, Restricted picklist, Sort",
      "description": "The status of the survey. Possible values include: NotStarted — The participant hasn't opened the survey. Started — The participant has opened the survey. Paused — The participant has paused the survey. Paused isn't available for invitations in which either OptionsAllowParticipantAccessTheirResponse or OptionsCollectAnonymousResponse is true. PartiallyCompleted — The participant has partially completed the survey. Available in API version 63.0 and later. Completed — The participant has completed the survey."
    },
    "SubmitterId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the Salesforce user, contact, or lead who completed the survey.",
      "relationship_name": "Submitter",
      "relationship_type": "Lookup",
      "refers_to": "Contact, Lead, User"
    },
    "SurveyId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "The ID of the survey that the participant completed."
    },
    "SurveyVersionId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "The ID of the version of the survey that the participant completed."
    }
  },
  "associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **SurveyResponseChangeEvent**: Change events are available for the object.",
  "field_reference": {
    "CompletionDateTime": {
      "field_label": "Response Completion Date and Time",
      "type": "datetime"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "DataMapperExecutionStatus": {
      "field_label": "Data Mapper Execution Status",
      "type": "picklist",
      "length": "255"
    },
    "Id": {
      "field_label": "Survey Response ID",
      "type": "id",
      "length": "18"
    },
    "InterviewGuid": {
      "field_label": "Interview GUID",
      "type": "string",
      "length": "255"
    },
    "InterviewId": {
      "field_label": "Interview ID",
      "type": "reference",
      "length": "18"
    },
    "InvitationId": {
      "field_label": "Survey Invitation ID",
      "type": "reference",
      "length": "18"
    },
    "IpAddress": {
      "field_label": "Response IP Address",
      "type": "string",
      "length": "39"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "Language": {
      "field_label": "Response Language",
      "type": "picklist",
      "length": "255"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "Latitude": {
      "field_label": "Response Latitude",
      "type": "double",
      "precision": "18",
      "scale": "15"
    },
    "Location": {
      "field_label": "Response Location",
      "type": "location",
      "digits": "0",
      "length": "0",
      "precision": "0",
      "scale": "0"
    },
    "Longitude": {
      "field_label": "Response Longitude",
      "type": "double",
      "precision": "18",
      "scale": "15"
    },
    "Name": {
      "field_label": "Response Name",
      "type": "string",
      "length": "255"
    },
    "Status": {
      "field_label": "Response Status",
      "type": "picklist",
      "length": "255"
    },
    "SubmitterId": {
      "field_label": "Response Submitter ID",
      "type": "reference",
      "length": "18"
    },
    "SurveyId": {
      "field_label": "Survey ID",
      "type": "reference",
      "length": "18"
    },
    "SurveyVersionId": {
      "field_label": "Survey Version ID",
      "type": "reference",
      "length": "18"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "precision",
    "scale",
    "digits"
  ]
}