latestOpenAPI 3.0.02026-08-08190133305.8 KB
109c0537cf77
ApiSurvey
Gets a single survey by its ID.
get/v2/surveys/{id}
Path parameters
idinteger required
Response
idinteger
namestring nullable
urlstring nullable
dateSurveyCreatedstring date-time
dateSurveyModifiedstring date-time
state'Active' | 'Inactive' | 'Pending' | 'Expired' | 'SurveyFeatureDisabled' | 'NotAvailableInThisVersion'
firstActiveDatestring date-time nullable
lastInactiveDatestring date-time nullable
scheduledStartDatestring date-time nullable
scheduledEndDatestring date-time nullable
confirmationMode'Text' | 'Url' | 'NotAvailableInThisVersion'
submissionMode'Single' | 'Multiple' | 'NotAvailableInThisVersion'
fieldCountinteger
notifyCreatorOnResponseboolean
respondentNotificationType'None' | 'Basic' | 'Campaign' | 'NotAvailableInThisVersion'
respondentNotificationCampaignIdinteger nullable
isAssignedToAddressBookboolean
assignedAddressBookTarget'AllContacts' | 'SpecificAddressBook' | 'NotAvailableInThisVersion'
assignedSpecificAddressBookIdinteger nullable
firstResponseDatestring date-time nullable
lastResponseDatestring date-time nullable
totalCompleteResponsesinteger
totalCompleteResponsesInLastDayinteger
totalCompleteResponsesInLastWeekinteger
totalIncompleteResponsesinteger
totalViewsinteger
totalBouncesinteger
timeToCompleteMaxinteger nullable
timeToCompleteMininteger nullable
timeToCompleteTotalinteger nullable
sourceDirectTotalinteger
sourceEmailTotalinteger
sourceEmbeddedTotalinteger
sourcePopoverTotalinteger
sourceFacebookTotalinteger
sourceTwitterTotalinteger
sourceGooglePlusTotalinteger
sourceOtherTotalinteger