experienceevent-survey-response-details.schema.md

Survey Response Details Schema

https://ns.adobe.com/xdm/mixins/experienceevent-survey-response-details

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Experimental	No	Forbidden	Permitted	mixins/experience-event/experienceevent-survey-response-details.schema.json

Survey Response Details Example

{
  "xdm:surveyResponse": {
    "xdm:surveyID": "",
    "xdm:surveySteps": {
      "xdm:tool-usage": {
        "xdm:toolUsageCancelled": 1,
        "xdm:toolUsageComplete": 1,
        "xdm:toolUsageFailure": 1,
        "xdm:toolUsageID": "T421",
        "xdm:toolUsageName": "calculator",
        "xdm:toolUsageSaved": 1,
        "xdm:toolUsageStart": 1,
        "xdm:toolUsageStep": 1,
        "xdm:toolUsageStepName": "enter parameters",
        "xdm:toolUsageSubmitted": 1,
        "xdm:toolUsageType": "generic"
      }
    }
  }
}

Survey Response Details Properties

Property	Type	Required	Defined by
xdm:surveyResponse	object	Optional	Survey Response Details (this schema)
*	any	Additional	this schema allows additional properties

xdm:surveyResponse

xdm:surveyResponse

• is optional
• type: object
• defined in this schema

xdm:surveyResponse Type

object with following properties:

Property	Type	Required
xdm:surveyAnswers	array	Optional
xdm:surveyID	string	Optional
xdm:surveyQuestions	array	Optional
xdm:surveySteps		Optional

xdm:surveyAnswers

Survey Answers

An array of the answers provided by the visitor within a survey.

xdm:surveyAnswers

• is optional
• type: string[]

xdm:surveyAnswers Type

Array type: string[]

All items must be of the type: string

xdm:surveyID

Survey ID

ID for the specific survey taken.

xdm:surveyID

• is optional
• type: string

xdm:surveyID Type

string

xdm:surveyQuestions

Survey Questions

An array of the questions presented to the visitor within a survey.

xdm:surveyQuestions

• is optional
• type: string[]

xdm:surveyQuestions Type

Array type: string[]

All items must be of the type: string

xdm:surveySteps

Survey Steps

Extension of toolUsage data type.

xdm:surveySteps

• is optional
• type: reference

xdm:surveySteps Type

• – https://ns.adobe.com/xdm/datatypes/tool-usage