{ "openapi": "3.0.0", "info": { "version": "0.2", "title": "Qualtrics API", "description": "Work with Qualtrics surveys, distributions and response events" }, "servers": [ { "url": "https://{apiRegion}.qualtrics.com/API/{apiVersion}", "description": "Qualtrics API endpoint for EU region", "variables": { "apiRegion": { "default": "fra1", "description": "Specify the Qualtrics datacenter prefix according to your account (find it at /Q/QualtricsIdsSection/IdsSection)" }, "apiVersion": { "default": "v3", "description": "API version to use - default v3" } } } ], "security": [ { "QualtricsAPIKeyAuth": [] } ], "paths": { "/survey-definitions/{Id}": { "get": { "summary": "Get a specific survey by its 'id' (e.g SV_123)", "operationId": "Getsurveys", "parameters": [ { "name": "Id", "in": "path", "required": true, "schema": { "type": "string" },"example":"SV_123" } ], "responses": { "200": { "description": "The requested survey", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyResponse" } } } } } } }, "/distributions": { "get": { "summary": "Get distributions for a given survey", "operationId": "Getdistributions", "parameters": [ { "$ref": "#/components/parameters/DistributionSurveyId" } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributionsResponse" } } } } } }, "post": { "summary": "Generate distribution links for a given survey", "operationId": "Generatedistributionlinks", "parameters": [], "responses": { "200": { "description": "OK", "headers": {} } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/requestBodies/CreateDistributionLinks" } } } } } }, "/distributions/{DistributionId}/links": { "get": { "summary": "Retrieve distribution links", "operationId": "Retrievedistributionlinks", "parameters": [ { "name": "surveyId", "in": "query", "required": true, "style": "form", "schema": { "type": "string", "example": "SV_daqxBqkZ5Di8aJU" } }, { "$ref": "#/components/parameters/DistributionId" } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveDistributionLinksResponse" } } } } } } }, "/directories/{DirectoryId}/mailinglists/{MailingListId}/contacts": { "post": { "summary": "Create a contact in a given mailing list", "operationId": "Createcontactinmailinglist", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/DirectoryId" }, { "$ref": "#/components/parameters/MailingListId" } ], "responses": { "200": { "description": "", "headers": {} } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/requestBodies/CreateContactInMailingList" } } } } } }, "/eventsubscriptions/": { "post": { "summary": "Subscribe to response event", "operationId": "webhook-trigger", "x-ms-trigger": "single", "parameters": [], "x-ms-notification-content": { "description": "Response schema", "schema": { "$ref": "#/components/schemas/EventSubscriptionHookSchema" } }, "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventSubscriptionsResponse" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/requestBodies/SubscribeToEventBody" }, "example": { "topics": "surveyengine.completedResponse.{SurveyID}", "publicationUrl": "https://prod-142.westeurope.logic.azure.com:443/workflows/", "encrypt": false } } } } },"delete":{ "summary": "Remove subscription to response event", "operationId": "WebhookDelete", "parameters": [], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventSubscriptionsResponse" } } } } } } }, "/eventsubscriptions/{SubscripionId}": { "get": { "summary": "Get event subscriptions", "operationId": "Geteventsubscriptions", "parameters": [ { "$ref": "#/components/parameters/SubscriptionId" } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventSubscriptionsResponse" } } } } } } } }, "components": { "securitySchemes": { "QualtricsAPIKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-TOKEN" } }, "responses": { "UnauthorizedError": { "description": "API key is missing or invalid", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } } }, "parameters": { "DistributionSurveyId": { "name": "surveyId", "in": "query", "required": true, "style": "form", "schema": { "type": "string", "example": "SV_123" } }, "DistributionId": { "name": "DistributionId", "in": "path", "required": true, "style": "simple", "schema": { "type": "string", "example": "DistributionId" } }, "DirectoryId": { "name": "DirectoryId", "required": true, "in": "path", "schema": { "type": "string" } }, "MailingListId": { "name": "MailingListId", "required": true, "in": "path", "schema": { "type": "string" } }, "SubscriptionId": { "name": "SubscriptionId", "required": true, "in": "path", "schema": { "type": "string" } }, "Content-Type": { "name": "Content-Type", "in": "header", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } } }, "requestBodies": { "CreateDistributionLinks": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "surveyId": { "type": "string" }, "linkType": { "type": "string" }, "description": { "type": "string" }, "action": { "type": "string", "default": "CreateDistribution" }, "expirationDate": { "type": "string", "example": "2021-01-21 00:00:00" }, "mailingListId": { "type": "string" } } } } } }, "CreateContactInMailingList": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "unsubscribed": { "type": "boolean" } } } } } }, "SubscribeToEventBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "topics": { "type": "string" }, "publicationUrl": { "type": "string" }, "encrypt": { "type": "boolean" } } } } } } }, "schemas": { "RetrieveDistributionLinksResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "elements": { "type": "array", "items": { "type": "object", "properties": { "contactId": { "type": "string" }, "transactionId": {}, "link": { "type": "string" }, "exceededContactFrequency": { "type": "boolean" }, "linkExpiration": { "type": "string" }, "status": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "externalDataReference": {}, "email": { "type": "string" }, "unsubscribed": { "type": "boolean" } }, "required": [ "contactId", "transactionId", "link", "exceededContactFrequency", "linkExpiration", "status", "lastName", "firstName", "externalDataReference", "email", "unsubscribed" ] } }, "nextPage": {} } }, "meta": { "type": "object", "properties": { "httpStatus": { "type": "string" }, "requestId": { "type": "string" } } } } }, "SurveyResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "QuestionCount": { "type": "string" }, "SurveyOptions": { "type": "object", "properties": { "ActiveResponseSet": { "type": "string" }, "AnonymizeResponse": { "type": "string" }, "Autoadvance": { "type": "string" }, "AutoadvancePages": { "type": "string" }, "Autofocus": { "type": "string" }, "AvailableLanguages": { "type": "object", "properties": { "EN": { "type": "array" } } }, "BackButton": { "type": "string" }, "BallotBoxStuffingPrevention": { "type": "string" }, "CollectGeoLocation": { "type": "string" }, "CustomStyles": { "type": "object", "properties": { "altRowStyles": { "type": "object", "properties": { "selector": { "type": "string" }, "styles": { "type": "object", "properties": { "backgroundColor": {} } } } }, "borderStyles": { "type": "object", "properties": { "selector": { "type": "string" }, "styles": { "type": "object", "properties": { "borderColor": {} } } } }, "choiceStyles": { "type": "object", "properties": { "selector": { "type": "string" }, "styles": { "type": "object", "properties": { "color": {}, "fontFamily": {}, "fontSize": {}, "fontStyle": {}, "fontWeight": {}, "textDecoration": {} } } } }, "customCSS": {}, "errorStyles": { "type": "object", "properties": { "selector": { "type": "string" }, "styles": { "type": "object", "properties": { "backgroundColor": {}, "borderColor": {}, "color": {} } } } }, "errorStylesBG": { "type": "object", "properties": { "selector": { "type": "string" }, "styles": { "type": "object", "properties": { "backgroundColor": {}, "color": {} } } } }, "footerStyles": { "type": "object", "properties": { "selector": { "type": "string" }, "styles": { "type": "object", "properties": { "color": {} } } } }, "headerStyles": { "type": "object", "properties": { "selector": { "type": "string" }, "styles": { "type": "object", "properties": { "color": {} } } } }, "highlightStyles": { "type": "object", "properties": { "selector": { "type": "string" }, "styles": { "type": "object", "properties": { "backgroundColor": {} } } } }, "highlightStylesAlt": { "type": "object", "properties": { "selector": { "type": "string" }, "styles": { "type": "object", "properties": { "backgroundColor": {} } } } }, "pageStyles": { "type": "object", "properties": { "selector": { "type": "string" }, "styles": { "type": "object", "properties": { "backgroundColor": {} } } } }, "questionSeparatorStyles": { "type": "object", "properties": { "selector": { "type": "string" }, "styles": { "type": "object", "properties": { "backgroundColor": {}, "display": {} } } } }, "questionStyles": { "type": "object", "properties": { "selector": { "type": "string" }, "styles": { "type": "object", "properties": { "color": {}, "fontFamily": {}, "fontSize": {}, "fontStyle": {}, "fontWeight": {}, "textDecoration": {} } } } }, "textEntryStyles": { "type": "object", "properties": { "selector": { "type": "string" }, "styles": { "type": "object", "properties": { "color": {} } } } }, "textStyles": { "type": "object", "properties": { "selector": { "type": "string" }, "styles": { "type": "object", "properties": { "color": {}, "fontFamily": {}, "fontSize": {}, "fontStyle": {}, "fontWeight": {}, "textDecoration": {} } } } } } }, "EOSMessage": { "type": "string" }, "EOSMessageLibrary": { "type": "string" }, "EOSRedirectURL": { "type": "string" }, "EmailThankYou": { "type": "string" }, "ExternalCSS": {}, "Footer": { "type": "string" }, "Header": { "type": "string" }, "HighlightQuestions": { "type": "string" }, "InactiveMessage": { "type": "string" }, "InactiveMessageLibrary": { "type": "string" }, "InactiveSurvey": { "type": "string" }, "NewScoring": { "type": "integer" }, "NextButton": { "type": "string" }, "NoIndex": { "type": "string" }, "PageTransition": { "type": "string" }, "PartialData": { "type": "string" }, "PartialDataCloseAfter": { "type": "string" }, "Password": { "type": "string" }, "PasswordProtection": { "type": "string" }, "PreviousButton": { "type": "string" }, "ProgressBarDisplay": { "type": "string" }, "ProtectSelectionIds": { "type": "boolean" }, "QuestionsPerPage": { "type": "string" }, "RecaptchaV3": { "type": "string" }, "RefererCheck": { "type": "string" }, "RefererURL": { "type": "string" }, "RelevantID": { "type": "string" }, "ResponseSummary": { "type": "string" }, "SaveAndContinue": { "type": "string" }, "SecureResponseFiles": { "type": "string" }, "ShowExportTags": { "type": "string" }, "Skin": { "type": "string" }, "SkinLibrary": { "type": "string" }, "SkinType": { "type": "string" }, "SurveyExpiration": {}, "SurveyMetaDescription": { "type": "string" }, "SurveyName": { "type": "string" }, "SurveyProtection": { "type": "string" }, "SurveyTermination": { "type": "string" }, "SurveyTitle": { "type": "string" }, "ThankYouEmailMessage": {}, "ThankYouEmailMessageLibrary": {}, "ValidateMessage": { "type": "string" }, "ValidationMessage": {}, "ValidationMessageLibrary": {}, "footerMid": { "type": "string" }, "headerMid": { "type": "string" }, "libraryId": { "type": "string" }, "nextButtonMid": { "type": "string" }, "previousButtonMid": { "type": "string" }, "SkinQuestionWidth": { "type": "integer" }, "SurveyLanguage": { "type": "string" }, "SurveyStartDate": {}, "SurveyExpirationDate": {}, "SurveyCreationDate": { "type": "string" } } }, "SurveyID": { "type": "string" }, "SurveyName": { "type": "string" }, "SurveyStatus": { "type": "string" }, "LastModified": { "type": "string" }, "BrandID": { "type": "string" }, "OwnerID": { "type": "string" }, "LastAccessed": {}, "CreatorID": { "type": "string" }, "LastActivated": { "type": "string" }, "Questions": { "type": "object", "properties": { "QID46": { "type": "object", "properties": { "ChoiceOrder": { "type": "array", "items": { "type": "string" } }, "Choices": { "type": "object", "properties": { "1": { "type": "object", "properties": { "Display": { "type": "string" } } }, "2": { "type": "object", "properties": { "Display": { "type": "string" } } }, "3": { "type": "object", "properties": { "Display": { "type": "string" } } }, "4": { "type": "object", "properties": { "Display": { "type": "string" } } }, "5": { "type": "object", "properties": { "Display": { "type": "string" } } } } }, "Configuration": { "type": "object", "properties": { "QuestionDescriptionOption": { "type": "string" }, "TextPosition": { "type": "string" } } }, "DataExportTag": { "type": "string" }, "DataVisibility": { "type": "object", "properties": { "Hidden": { "type": "boolean" }, "Private": { "type": "boolean" } } }, "DefaultChoices": { "type": "boolean" }, "GradingData": { "type": "array" }, "Language": { "type": "array" }, "NextAnswerId": { "type": "integer" }, "NextChoiceId": { "type": "integer" }, "QuestionDescription": { "type": "string" }, "QuestionID": { "type": "string" }, "QuestionText": { "type": "string" }, "QuestionType": { "type": "string" }, "Selector": { "type": "string" }, "SubSelector": { "type": "string" }, "Validation": { "type": "object", "properties": { "Settings": { "type": "object", "properties": { "ForceResponse": { "type": "string" }, "ForceResponseType": { "type": "string" }, "Type": { "type": "string" } } } } }, "QuestionText_Unsafe": { "type": "string" } } }, "QID48": { "type": "object", "properties": { "ChoiceOrder": { "type": "array", "items": { "type": "string" } }, "Choices": { "type": "object", "properties": { "1": { "type": "object", "properties": { "Display": { "type": "string" } } }, "2": { "type": "object", "properties": { "Display": { "type": "string" } } }, "3": { "type": "object", "properties": { "Display": { "type": "string" } } }, "4": { "type": "object", "properties": { "Display": { "type": "string" } } }, "5": { "type": "object", "properties": { "Display": { "type": "string" } } } } }, "Configuration": { "type": "object", "properties": { "QuestionDescriptionOption": { "type": "string" }, "TextPosition": { "type": "string" } } }, "DataExportTag": { "type": "string" }, "DataVisibility": { "type": "object", "properties": { "Hidden": { "type": "boolean" }, "Private": { "type": "boolean" } } }, "DefaultChoices": { "type": "boolean" }, "GradingData": { "type": "array" }, "Language": { "type": "array" }, "NextAnswerId": { "type": "integer" }, "NextChoiceId": { "type": "integer" }, "QuestionDescription": { "type": "string" }, "QuestionID": { "type": "string" }, "QuestionText": { "type": "string" }, "QuestionType": { "type": "string" }, "Selector": { "type": "string" }, "SubSelector": { "type": "string" }, "Validation": { "type": "object", "properties": { "Settings": { "type": "object", "properties": { "ForceResponse": { "type": "string" }, "ForceResponseType": { "type": "string" }, "Type": { "type": "string" } } } } }, "QuestionText_Unsafe": { "type": "string" } } }, "QID50": { "type": "object", "properties": { "ChoiceOrder": { "type": "array", "items": { "type": "string" } }, "Choices": { "type": "object", "properties": { "1": { "type": "object", "properties": { "Display": { "type": "string" } } }, "2": { "type": "object", "properties": { "Display": { "type": "string" } } }, "3": { "type": "object", "properties": { "Display": { "type": "string" } } }, "4": { "type": "object", "properties": { "Display": { "type": "string" } } }, "5": { "type": "object", "properties": { "Display": { "type": "string" } } } } }, "Configuration": { "type": "object", "properties": { "QuestionDescriptionOption": { "type": "string" }, "TextPosition": { "type": "string" } } }, "DataExportTag": { "type": "string" }, "DataVisibility": { "type": "object", "properties": { "Hidden": { "type": "boolean" }, "Private": { "type": "boolean" } } }, "DefaultChoices": { "type": "boolean" }, "GradingData": { "type": "array" }, "Language": { "type": "array" }, "NextAnswerId": { "type": "integer" }, "NextChoiceId": { "type": "integer" }, "QuestionDescription": { "type": "string" }, "QuestionID": { "type": "string" }, "QuestionText": { "type": "string" }, "QuestionType": { "type": "string" }, "Selector": { "type": "string" }, "SubSelector": { "type": "string" }, "Validation": { "type": "object", "properties": { "Settings": { "type": "object", "properties": { "ForceResponse": { "type": "string" }, "ForceResponseType": { "type": "string" }, "Type": { "type": "string" } } } } }, "QuestionText_Unsafe": { "type": "string" } } }, "QID52": { "type": "object", "properties": { "ChoiceOrder": { "type": "array", "items": { "type": "string" } }, "Choices": { "type": "object", "properties": { "1": { "type": "object", "properties": { "Display": { "type": "string" } } }, "2": { "type": "object", "properties": { "Display": { "type": "string" } } }, "3": { "type": "object", "properties": { "Display": { "type": "string" } } }, "4": { "type": "object", "properties": { "Display": { "type": "string" } } }, "5": { "type": "object", "properties": { "Display": { "type": "string" } } } } }, "Configuration": { "type": "object", "properties": { "QuestionDescriptionOption": { "type": "string" }, "TextPosition": { "type": "string" } } }, "DataExportTag": { "type": "string" }, "DataVisibility": { "type": "object", "properties": { "Hidden": { "type": "boolean" }, "Private": { "type": "boolean" } } }, "DefaultChoices": { "type": "boolean" }, "GradingData": { "type": "array" }, "Language": { "type": "array" }, "NextAnswerId": { "type": "integer" }, "NextChoiceId": { "type": "integer" }, "QuestionDescription": { "type": "string" }, "QuestionID": { "type": "string" }, "QuestionText": { "type": "string" }, "QuestionType": { "type": "string" }, "Selector": { "type": "string" }, "SubSelector": { "type": "string" }, "Validation": { "type": "object", "properties": { "Settings": { "type": "object", "properties": { "ForceResponse": { "type": "string" }, "ForceResponseType": { "type": "string" }, "Type": { "type": "string" } } } } }, "QuestionText_Unsafe": { "type": "string" } } }, "QID54": { "type": "object", "properties": { "ChoiceOrder": { "type": "array", "items": { "type": "string" } }, "Choices": { "type": "object", "properties": { "1": { "type": "object", "properties": { "Display": { "type": "string" } } }, "2": { "type": "object", "properties": { "Display": { "type": "string" } } }, "3": { "type": "object", "properties": { "Display": { "type": "string" } } }, "4": { "type": "object", "properties": { "Display": { "type": "string" } } }, "5": { "type": "object", "properties": { "Display": { "type": "string" } } } } }, "Configuration": { "type": "object", "properties": { "QuestionDescriptionOption": { "type": "string" }, "TextPosition": { "type": "string" } } }, "DataExportTag": { "type": "string" }, "DataVisibility": { "type": "object", "properties": { "Hidden": { "type": "boolean" }, "Private": { "type": "boolean" } } }, "DefaultChoices": { "type": "boolean" }, "GradingData": { "type": "array" }, "Language": { "type": "array" }, "NextAnswerId": { "type": "integer" }, "NextChoiceId": { "type": "integer" }, "QuestionDescription": { "type": "string" }, "QuestionID": { "type": "string" }, "QuestionText": { "type": "string" }, "QuestionType": { "type": "string" }, "Selector": { "type": "string" }, "SubSelector": { "type": "string" }, "Validation": { "type": "object", "properties": { "Settings": { "type": "object", "properties": { "ForceResponse": { "type": "string" }, "ForceResponseType": { "type": "string" }, "Type": { "type": "string" } } } } }, "QuestionText_Unsafe": { "type": "string" } } }, "QID45": { "type": "object", "properties": { "ChoiceOrder": { "type": "array", "items": { "type": "string" } }, "Choices": { "type": "object", "properties": { "1": { "type": "object", "properties": { "Display": { "type": "string" } } }, "2": { "type": "object", "properties": { "Display": { "type": "string" } } }, "3": { "type": "object", "properties": { "Display": { "type": "string" } } }, "4": { "type": "object", "properties": { "Display": { "type": "string" } } }, "5": { "type": "object", "properties": { "Display": { "type": "string" } } } } }, "Configuration": { "type": "object", "properties": { "QuestionDescriptionOption": { "type": "string" }, "TextPosition": { "type": "string" } } }, "DataExportTag": { "type": "string" }, "DataVisibility": { "type": "object", "properties": { "Hidden": { "type": "boolean" }, "Private": { "type": "boolean" } } }, "DefaultChoices": { "type": "boolean" }, "GradingData": { "type": "array" }, "Language": { "type": "array" }, "NextAnswerId": { "type": "integer" }, "NextChoiceId": { "type": "integer" }, "QuestionDescription": { "type": "string" }, "QuestionID": { "type": "string" }, "QuestionText": { "type": "string" }, "QuestionType": { "type": "string" }, "Selector": { "type": "string" }, "SubSelector": { "type": "string" }, "Validation": { "type": "object", "properties": { "Settings": { "type": "object", "properties": { "ForceResponse": { "type": "string" }, "ForceResponseType": { "type": "string" }, "Type": { "type": "string" } } } } }, "QuestionText_Unsafe": { "type": "string" } } }, "QID47": { "type": "object", "properties": { "ChoiceOrder": { "type": "array", "items": { "type": "string" } }, "Choices": { "type": "object", "properties": { "1": { "type": "object", "properties": { "Display": { "type": "string" } } }, "2": { "type": "object", "properties": { "Display": { "type": "string" } } }, "3": { "type": "object", "properties": { "Display": { "type": "string" } } }, "4": { "type": "object", "properties": { "Display": { "type": "string" } } }, "5": { "type": "object", "properties": { "Display": { "type": "string" } } } } }, "Configuration": { "type": "object", "properties": { "QuestionDescriptionOption": { "type": "string" }, "TextPosition": { "type": "string" } } }, "DataExportTag": { "type": "string" }, "DataVisibility": { "type": "object", "properties": { "Hidden": { "type": "boolean" }, "Private": { "type": "boolean" } } }, "DefaultChoices": { "type": "boolean" }, "GradingData": { "type": "array" }, "Language": { "type": "array" }, "NextAnswerId": { "type": "integer" }, "NextChoiceId": { "type": "integer" }, "QuestionDescription": { "type": "string" }, "QuestionID": { "type": "string" }, "QuestionText": { "type": "string" }, "QuestionType": { "type": "string" }, "Selector": { "type": "string" }, "SubSelector": { "type": "string" }, "Validation": { "type": "object", "properties": { "Settings": { "type": "object", "properties": { "ForceResponse": { "type": "string" }, "ForceResponseType": { "type": "string" }, "Type": { "type": "string" } } } } }, "QuestionText_Unsafe": { "type": "string" } } }, "QID49": { "type": "object", "properties": { "ChoiceOrder": { "type": "array", "items": { "type": "string" } }, "Choices": { "type": "object", "properties": { "1": { "type": "object", "properties": { "Display": { "type": "string" } } }, "2": { "type": "object", "properties": { "Display": { "type": "string" } } }, "3": { "type": "object", "properties": { "Display": { "type": "string" } } }, "4": { "type": "object", "properties": { "Display": { "type": "string" } } }, "5": { "type": "object", "properties": { "Display": { "type": "string" } } } } }, "Configuration": { "type": "object", "properties": { "QuestionDescriptionOption": { "type": "string" }, "TextPosition": { "type": "string" } } }, "DataExportTag": { "type": "string" }, "DataVisibility": { "type": "object", "properties": { "Hidden": { "type": "boolean" }, "Private": { "type": "boolean" } } }, "DefaultChoices": { "type": "boolean" }, "GradingData": { "type": "array" }, "Language": { "type": "array" }, "NextAnswerId": { "type": "integer" }, "NextChoiceId": { "type": "integer" }, "QuestionDescription": { "type": "string" }, "QuestionID": { "type": "string" }, "QuestionText": { "type": "string" }, "QuestionType": { "type": "string" }, "Selector": { "type": "string" }, "SubSelector": { "type": "string" }, "Validation": { "type": "object", "properties": { "Settings": { "type": "object", "properties": { "ForceResponse": { "type": "string" }, "ForceResponseType": { "type": "string" }, "Type": { "type": "string" } } } } }, "QuestionText_Unsafe": { "type": "string" } } }, "QID51": { "type": "object", "properties": { "ChoiceOrder": { "type": "array", "items": { "type": "string" } }, "Choices": { "type": "object", "properties": { "1": { "type": "object", "properties": { "Display": { "type": "string" } } }, "2": { "type": "object", "properties": { "Display": { "type": "string" } } }, "3": { "type": "object", "properties": { "Display": { "type": "string" } } }, "4": { "type": "object", "properties": { "Display": { "type": "string" } } }, "5": { "type": "object", "properties": { "Display": { "type": "string" } } } } }, "Configuration": { "type": "object", "properties": { "QuestionDescriptionOption": { "type": "string" }, "TextPosition": { "type": "string" } } }, "DataExportTag": { "type": "string" }, "DataVisibility": { "type": "object", "properties": { "Hidden": { "type": "boolean" }, "Private": { "type": "boolean" } } }, "DefaultChoices": { "type": "boolean" }, "GradingData": { "type": "array" }, "Language": { "type": "array" }, "NextAnswerId": { "type": "integer" }, "NextChoiceId": { "type": "integer" }, "QuestionDescription": { "type": "string" }, "QuestionID": { "type": "string" }, "QuestionText": { "type": "string" }, "QuestionType": { "type": "string" }, "Selector": { "type": "string" }, "SubSelector": { "type": "string" }, "Validation": { "type": "object", "properties": { "Settings": { "type": "object", "properties": { "ForceResponse": { "type": "string" }, "ForceResponseType": { "type": "string" }, "Type": { "type": "string" } } } } }, "QuestionText_Unsafe": { "type": "string" } } }, "QID53": { "type": "object", "properties": { "ChoiceOrder": { "type": "array", "items": { "type": "string" } }, "Choices": { "type": "object", "properties": { "1": { "type": "object", "properties": { "Display": { "type": "string" } } }, "2": { "type": "object", "properties": { "Display": { "type": "string" } } }, "3": { "type": "object", "properties": { "Display": { "type": "string" } } }, "4": { "type": "object", "properties": { "Display": { "type": "string" } } }, "5": { "type": "object", "properties": { "Display": { "type": "string" } } } } }, "Configuration": { "type": "object", "properties": { "QuestionDescriptionOption": { "type": "string" }, "TextPosition": { "type": "string" } } }, "DataExportTag": { "type": "string" }, "DataVisibility": { "type": "object", "properties": { "Hidden": { "type": "boolean" }, "Private": { "type": "boolean" } } }, "DefaultChoices": { "type": "boolean" }, "GradingData": { "type": "array" }, "Language": { "type": "array" }, "NextAnswerId": { "type": "integer" }, "NextChoiceId": { "type": "integer" }, "QuestionDescription": { "type": "string" }, "QuestionID": { "type": "string" }, "QuestionText": { "type": "string" }, "QuestionType": { "type": "string" }, "Selector": { "type": "string" }, "SubSelector": { "type": "string" }, "Validation": { "type": "object", "properties": { "Settings": { "type": "object", "properties": { "ForceResponse": { "type": "string" }, "ForceResponseType": { "type": "string" }, "Type": { "type": "string" } } } } }, "QuestionText_Unsafe": { "type": "string" } } }, "QID36": { "type": "object", "properties": { "Configuration": { "type": "object", "properties": { "AllowFreeResponse": { "type": "string" }, "QuestionDescriptionOption": { "type": "string" } } }, "DataExportTag": { "type": "string" }, "DataVisibility": { "type": "object", "properties": { "Hidden": { "type": "boolean" }, "Private": { "type": "boolean" } } }, "DefaultChoices": { "type": "boolean" }, "GradingData": { "type": "array" }, "Language": { "type": "array" }, "NextAnswerId": { "type": "integer" }, "NextChoiceId": { "type": "integer" }, "QuestionDescription": { "type": "string" }, "QuestionID": { "type": "string" }, "QuestionText": { "type": "string" }, "QuestionType": { "type": "string" }, "Selector": { "type": "string" }, "Validation": { "type": "object", "properties": { "Settings": { "type": "object", "properties": { "ForceResponse": { "type": "string" }, "ForceResponseType": { "type": "string" }, "Type": { "type": "string" } } } } }, "QuestionText_Unsafe": { "type": "string" } } }, "QID42": { "type": "object", "properties": { "ChoiceOrder": { "type": "array", "items": { "type": "string" } }, "Choices": { "type": "array", "items": { "type": "object", "properties": { "Display": { "type": "string" } }, "required": [ "Display" ] } }, "ColumnLabels": { "type": "array", "items": { "type": "object", "properties": { "Display": { "type": "string" }, "IsLabelDefault": { "type": "boolean" } }, "required": [ "Display", "IsLabelDefault" ] } }, "Configuration": { "type": "object", "properties": { "QuestionDescriptionOption": { "type": "string" } } }, "DataExportTag": { "type": "string" }, "DataVisibility": { "type": "object", "properties": { "Hidden": { "type": "boolean" }, "Private": { "type": "boolean" } } }, "DefaultChoices": { "type": "boolean" }, "GradingData": { "type": "array" }, "Language": { "type": "array" }, "NextAnswerId": { "type": "integer" }, "NextChoiceId": { "type": "integer" }, "QuestionDescription": { "type": "string" }, "QuestionID": { "type": "string" }, "QuestionText": { "type": "string" }, "QuestionType": { "type": "string" }, "Selector": { "type": "string" }, "Validation": { "type": "object", "properties": { "Settings": { "type": "object", "properties": { "ForceResponse": { "type": "string" }, "ForceResponseType": { "type": "string" }, "Type": { "type": "string" } } } } }, "QuestionText_Unsafe": { "type": "string" } } }, "QID43": { "type": "object", "properties": { "Configuration": { "type": "object", "properties": { "QuestionDescriptionOption": { "type": "string" } } }, "DataExportTag": { "type": "string" }, "DataVisibility": { "type": "object", "properties": { "Hidden": { "type": "boolean" }, "Private": { "type": "boolean" } } }, "DefaultChoices": { "type": "boolean" }, "GradingData": { "type": "array" }, "Language": { "type": "array" }, "NextAnswerId": { "type": "integer" }, "NextChoiceId": { "type": "integer" }, "QuestionDescription": { "type": "string" }, "QuestionID": { "type": "string" }, "QuestionText": { "type": "string" }, "QuestionType": { "type": "string" }, "Selector": { "type": "string" }, "Validation": { "type": "object", "properties": { "Settings": { "type": "object", "properties": { "ForceResponse": { "type": "string" }, "ForceResponseType": { "type": "string" }, "Type": { "type": "string" } } } } }, "QuestionText_Unsafe": { "type": "string" } } }, "QID21": { "type": "object", "properties": { "Configuration": { "type": "object", "properties": { "NumColumns": { "type": "integer" }, "QuestionDescriptionOption": { "type": "string" } } }, "DataExportTag": { "type": "string" }, "DataVisibility": { "type": "object", "properties": { "Hidden": { "type": "boolean" }, "Private": { "type": "boolean" } } }, "DefaultChoices": { "type": "boolean" }, "GradingData": { "type": "array" }, "Language": { "type": "array" }, "NextAnswerId": { "type": "integer" }, "NextChoiceId": { "type": "integer" }, "QuestionDescription": { "type": "string" }, "QuestionID": { "type": "string" }, "QuestionText": { "type": "string" }, "QuestionType": { "type": "string" }, "Selector": { "type": "string" }, "Validation": { "type": "object", "properties": { "Settings": { "type": "object", "properties": { "ContentType": { "type": "string" }, "ForceResponse": { "type": "string" }, "ForceResponseType": { "type": "string" }, "Type": { "type": "string" }, "ValidDateType": { "type": "string" }, "ValidNumber": { "type": "object", "properties": { "Max": { "type": "string" }, "Min": { "type": "string" }, "NumDecimals": { "type": "string" } } }, "ValidPhoneType": { "type": "string" }, "ValidZipType": { "type": "string" } } } } }, "QuestionText_Unsafe": { "type": "string" } } }, "QID31": { "type": "object", "properties": { "Configuration": { "type": "object", "properties": { "QuestionDescriptionOption": { "type": "string" } } }, "DataExportTag": { "type": "string" }, "DataVisibility": { "type": "object", "properties": { "Hidden": { "type": "boolean" }, "Private": { "type": "boolean" } } }, "DefaultChoices": { "type": "boolean" }, "GradingData": { "type": "array" }, "Language": { "type": "array" }, "NextAnswerId": { "type": "integer" }, "NextChoiceId": { "type": "integer" }, "QuestionDescription": { "type": "string" }, "QuestionID": { "type": "string" }, "QuestionText": { "type": "string" }, "QuestionType": { "type": "string" }, "Selector": { "type": "string" }, "Validation": { "type": "object", "properties": { "Settings": { "type": "object", "properties": { "ForceResponse": { "type": "string" }, "ForceResponseType": { "type": "string" }, "MinChars": { "type": "string" }, "TotalChars": { "type": "string" }, "Type": { "type": "string" } } } } }, "QuestionText_Unsafe": { "type": "string" } } }, "QID23": { "type": "object", "properties": { "ChoiceOrder": { "type": "array", "items": { "type": "string" } }, "Choices": { "type": "object", "properties": { "1": { "type": "object", "properties": { "Display": { "type": "string" } } }, "2": { "type": "object", "properties": { "Display": { "type": "string" } } }, "3": { "type": "object", "properties": { "Display": { "type": "string" } } }, "4": { "type": "object", "properties": { "Display": { "type": "string" } } }, "5": { "type": "object", "properties": { "Display": { "type": "string" } } }, "6": { "type": "object", "properties": { "Display": { "type": "string" } } }, "7": { "type": "object", "properties": { "Display": { "type": "string" }, "TextEntry": { "type": "string" } } }, "8": { "type": "object", "properties": { "Display": { "type": "string" } } } } }, "Configuration": { "type": "object", "properties": { "QuestionDescriptionOption": { "type": "string" } } }, "DataExportTag": { "type": "string" }, "DataVisibility": { "type": "object", "properties": { "Hidden": { "type": "boolean" }, "Private": { "type": "boolean" } } }, "Language": { "type": "array" }, "NextAnswerId": { "type": "integer" }, "NextChoiceId": { "type": "integer" }, "QuestionDescription": { "type": "string" }, "QuestionID": { "type": "string" }, "QuestionText": { "type": "string" }, "QuestionType": { "type": "string" }, "Selector": { "type": "string" }, "SubSelector": { "type": "string" }, "Validation": { "type": "object", "properties": { "Settings": { "type": "object", "properties": { "ForceResponse": { "type": "string" }, "ForceResponseType": { "type": "string" }, "Type": { "type": "string" } } } } }, "QuestionText_Unsafe": { "type": "string" } } } } }, "Blocks": { "type": "object", "properties": { "BL_3guR0F0lGVfF5tj": { "type": "object", "properties": { "BlockElements": { "type": "array", "items": { "type": "object", "properties": { "QuestionID": { "type": "string" }, "Type": { "type": "string" } }, "required": [ "QuestionID", "Type" ] } }, "Description": { "type": "string" }, "ID": { "type": "string" }, "Options": { "type": "object", "properties": { "BlockLocking": { "type": "string" }, "BlockVisibility": { "type": "string" }, "RandomizeQuestions": { "type": "string" } } }, "Type": { "type": "string" } } }, "BL_9uZsNkfstasQRI3": { "type": "object", "properties": { "BlockElements": { "type": "array", "items": { "type": "object", "properties": { "QuestionID": { "type": "string" }, "Type": { "type": "string" } }, "required": [ "Type" ] } }, "Description": { "type": "string" }, "ID": { "type": "string" }, "Options": { "type": "object", "properties": { "BlockLocking": { "type": "string" }, "Looping": { "type": "string" }, "LoopingOptions": {}, "RandomizeQuestions": { "type": "string" } } }, "SubType": { "type": "string" }, "Type": { "type": "string" } } }, "BL_9uZsNkfstasQRI4": { "type": "object", "properties": { "BlockElements": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string" }, "QuestionID": { "type": "string" } }, "required": [ "Type" ] } }, "Description": { "type": "string" }, "ID": { "type": "string" }, "Options": { "type": "object", "properties": { "BlockLocking": { "type": "string" }, "Looping": { "type": "string" }, "LoopingOptions": {}, "RandomizeQuestions": { "type": "string" } } }, "SubType": { "type": "string" }, "Type": { "type": "string" } } }, "BL_9z6tnZPkYBL62LH": { "type": "object", "properties": { "BlockElements": { "type": "array", "items": { "type": "object", "properties": { "QuestionID": { "type": "string" }, "Type": { "type": "string" } }, "required": [ "Type" ] } }, "Description": { "type": "string" }, "ID": { "type": "string" }, "Options": { "type": "object", "properties": { "BlockLocking": { "type": "string" }, "BlockVisibility": { "type": "string" }, "RandomizeQuestions": { "type": "string" } } }, "SubType": { "type": "string" }, "Type": { "type": "string" } } }, "BL_cNJhXeMWCFAFQLH": { "type": "object", "properties": { "BlockElements": { "type": "array", "items": { "type": "object", "properties": { "QuestionID": { "type": "string" }, "Type": { "type": "string" } }, "required": [ "Type" ] } }, "Description": { "type": "string" }, "ID": { "type": "string" }, "Options": { "type": "object", "properties": { "BlockLocking": { "type": "string" }, "BlockVisibility": { "type": "string" }, "RandomizeQuestions": { "type": "string" } } }, "SubType": { "type": "string" }, "Type": { "type": "string" } } }, "BL_0ijSd5XY4gJbogd": { "type": "object", "properties": { "BlockElements": { "type": "array", "items": { "type": "object", "properties": { "QuestionID": { "type": "string" }, "Type": { "type": "string" } }, "required": [ "QuestionID", "Type" ] } }, "Description": { "type": "string" }, "ID": { "type": "string" }, "SubType": { "type": "string" }, "Type": { "type": "string" } } }, "BL_9uZsNkfstasQRI0": { "type": "object", "properties": { "BlockElements": { "type": "array", "items": { "type": "object", "properties": { "QuestionID": { "type": "string" }, "Type": { "type": "string" } }, "required": [ "Type" ] } }, "Description": { "type": "string" }, "ID": { "type": "string" }, "Options": { "type": "object", "properties": { "BlockLocking": { "type": "string" }, "Looping": { "type": "string" }, "LoopingOptions": {}, "RandomizeQuestions": { "type": "string" } } }, "SubType": { "type": "string" }, "Type": { "type": "string" } } }, "BL_9uZsNkfstasQRI1": { "type": "object", "properties": { "BlockElements": { "type": "array", "items": { "type": "object", "properties": { "QuestionID": { "type": "string" }, "Type": { "type": "string" } }, "required": [ "Type" ] } }, "Description": { "type": "string" }, "ID": { "type": "string" }, "Options": { "type": "object", "properties": { "BlockLocking": { "type": "string" }, "Looping": { "type": "string" }, "LoopingOptions": {}, "RandomizeQuestions": { "type": "string" } } }, "SubType": { "type": "string" }, "Type": { "type": "string" } } }, "BL_9uZsNkfstasQRI2": { "type": "object", "properties": { "BlockElements": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string" } }, "required": [ "Type" ] } }, "Description": { "type": "string" }, "ID": { "type": "string" }, "Options": { "type": "object", "properties": { "BlockLocking": { "type": "string" }, "Looping": { "type": "string" }, "LoopingOptions": {}, "RandomizeQuestions": { "type": "string" } } }, "SubType": { "type": "string" }, "Type": { "type": "string" } } } } }, "ResponseSets": { "type": "object", "properties": { "RS_6LQ18e9OczDfNb0": { "type": "string" } } }, "SurveyFlow": { "type": "object", "properties": { "Flow": { "type": "array", "items": { "type": "object", "properties": { "Description": { "type": "string" }, "Flow": { "type": "array", "items": { "type": "object", "properties": { "Description": { "type": "string" }, "EmbeddedData": { "type": "array", "items": { "type": "object", "properties": { "DataVisibility": { "type": "array" }, "Description": { "type": "string" }, "Field": { "type": "string" }, "FlowOnly": { "type": "boolean" }, "Type": { "type": "string" }, "Value": { "type": "string" }, "VariableType": { "type": "string" } }, "required": [ "DataVisibility", "Description", "Field", "FlowOnly", "Type", "Value", "VariableType" ] } }, "FlowID": { "type": "string" }, "Type": { "type": "string" } }, "required": [ "Description", "EmbeddedData", "FlowID", "Type" ] } }, "FlowID": { "type": "string" }, "Type": { "type": "string" }, "UIActions": { "type": "object", "properties": { "Delete": { "type": "boolean" }, "Duplicate": { "type": "boolean" }, "ViewFlow": { "type": "boolean" } } }, "EmbeddedData": { "type": "array", "items": { "type": "object", "properties": { "AnalyzeText": { "type": "boolean" }, "DataVisibility": { "type": "array" }, "Description": { "type": "string" }, "Field": { "type": "string" }, "Type": { "type": "string" }, "Value": { "type": "string" }, "VariableType": { "type": "string" } }, "required": [ "AnalyzeText", "DataVisibility", "Description", "Field", "Type", "Value", "VariableType" ] } }, "ID": { "type": "string" }, "SubSet": { "type": "integer" } }, "required": [ "FlowID", "Type" ] } }, "FlowID": { "type": "string" }, "Properties": { "type": "object", "properties": { "Count": { "type": "integer" }, "RemovedFieldsets": { "type": "array" } } }, "Type": { "type": "string" } } }, "Scoring": { "type": "object", "properties": { "AutoScoringCategory": {}, "DefaultScoringCategory": {}, "ScoringCategories": { "type": "array" }, "ScoringCategoryGroups": { "type": "array" }, "ScoringSummaryAfterQuestions": { "type": "integer" }, "ScoringSummaryAfterSurvey": { "type": "integer" }, "ScoringSummaryCategory": {} } }, "ProjectInfo": { "type": "object", "properties": { "SurveyID": { "type": "string" }, "ProjectCategory": { "type": "string" }, "ProjectType": { "type": "string" }, "CompositionType": {}, "ContentBundle": {} } }, "BrandBaseURL": { "type": "string" } } } } }, "DistributionsResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "elements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "parentDistributionId": {}, "ownerId": { "type": "string" }, "organizationId": { "type": "string" }, "requestStatus": { "type": "string" }, "requestType": { "type": "string" }, "sendDate": { "type": "string" }, "createdDate": { "type": "string" }, "modifiedDate": { "type": "string" }, "customHeaders": { "type": "object", "properties": {} }, "headers": { "type": "object", "properties": { "fromEmail": {}, "replyToEmail": {}, "fromName": {} } }, "recipients": { "type": "object", "properties": { "mailingListId": { "type": "string" }, "contactId": {}, "libraryId": { "type": "string" }, "sampleId": {} } }, "message": { "type": "object", "properties": { "libraryId": {}, "messageId": {}, "messageText": {} } }, "surveyLink": { "type": "object", "properties": { "surveyId": { "type": "string" }, "expirationDate": { "type": "string" }, "linkType": { "type": "string" } } }, "embeddedData": {}, "stats": { "type": "object", "properties": { "sent": { "type": "integer" }, "failed": { "type": "integer" }, "started": { "type": "integer" }, "bounced": { "type": "integer" }, "opened": { "type": "integer" }, "skipped": { "type": "integer" }, "finished": { "type": "integer" }, "complaints": { "type": "integer" }, "blocked": { "type": "integer" } } } }, "required": [ "id", "parentDistributionId", "ownerId", "organizationId", "requestStatus", "requestType", "sendDate", "createdDate", "modifiedDate", "customHeaders", "headers", "recipients", "message", "surveyLink", "embeddedData", "stats" ] } }, "nextPage": {} } }, "meta": { "type": "object", "properties": { "httpStatus": { "type": "string" }, "requestId": { "type": "string" } } } } }, "EventSubscriptionsResponse": { "type": "object", "properties": { "result": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "string" } } }, "meta": { "type": "object", "properties": { "httpStatus": { "type": "string" } } } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "httpStatus": { "type": "string" } } } } }, "EventSubscriptionHookSchema": { "type": "object", "properties": { "$content-type": { "type": "string", "default": "application/x-www-form-urlencoded" }, "$content": { "type": "string" }, "$formdata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] } } } } } } }