Survey

Representation of a survey

Name	Description	Type	Additional information
Id Id of a survey. Type integer
Id	Id of a survey.	integer
Title Title of a survey. Type string
Title	Title of a survey.	string
SurveyStatusId The survey status id. Type integer Additional info 3/lookup/surveystatus
SurveyStatusId	The survey status id.	integer	3/lookup/surveystatus
CreateDate Date the survey has been created. Type date Additional info ISO 8601 format
CreateDate	Date the survey has been created.	date	ISO 8601 format
LastModifyDate Most recent date the survey has been modified. Type date Additional info ISO 8601 format
LastModifyDate	Most recent date the survey has been modified.	date	ISO 8601 format
StartDate Date the survey will start/has started. Type date Additional info ISO 8601 format
StartDate	Date the survey will start/has started.	date	ISO 8601 format
EndDate Date the survey will end/has ended. Type date Additional info ISO 8601 format
EndDate	Date the survey will end/has ended.	date	ISO 8601 format
IsTrial Indicate if this survey is a trial survey. Type boolean Additional info Trials surveys are limited to 25 respondents.
IsTrial	Indicate if this survey is a trial survey.	boolean	Trials surveys are limited to 25 respondents.
PanelistCount Amount of panelist who are linked to the survey. Type integer
PanelistCount	Amount of panelist who are linked to the survey.	integer
RespondentCount Amount of respondents for the survey. Type integer
RespondentCount	Amount of respondents for the survey.	integer
CreatedBy Name of the user who created the survey. Type string
CreatedBy	Name of the user who created the survey.	string
QuestionCount Amount of questions in this survey. Type integer
QuestionCount	Amount of questions in this survey.	integer
Langs List of the available languages. Each language will be represented with its 2-letter ISo 639-1 language code. Type Collection of Object
Langs	List of the available languages. Each language will be represented with its 2-letter ISo 639-1 language code.	Collection of Object
Channels Show which channels are available in use for the survey. Type SurveyChannels
Channels	Show which channels are available in use for the survey.	SurveyChannels
Options Extended settings for a survey Type SurveyOptions Additional info Only available when retrieving a survey by id
Options	Extended settings for a survey	SurveyOptions	Only available when retrieving a survey by id
Questions More details for the questions of the survey. Only available when retrieving a single Survey except when list in the expand parameter. Type Collection of SurveyQuestion Additional info Expandable
Questions	More details for the questions of the survey. Only available when retrieving a single Survey except when list in the expand parameter.	Collection of SurveyQuestion	Expandable
RespondentVisibility Visibility settings for panelists of the survey. Only available when retrieving a single Survey except when list in the expand parameter. Type RespondentVisibility Additional info Expandable
RespondentVisibility	Visibility settings for panelists of the survey. Only available when retrieving a single Survey except when list in the expand parameter.	RespondentVisibility	Expandable
DefaultLang Default 2-letter ISO 639-1 language code. The default language for the survey will be used when retrieving questions without passing the lang parameter. Type string Additional info Required, Max length: 2
DefaultLang	Default 2-letter ISO 639-1 language code. The default language for the survey will be used when retrieving questions without passing the lang parameter.	string	Required, Max length: 2
ClientRef Your internal reference. The reference will also appear on the invoice next to the project name of your survey. Type string Additional info Max length: 80
ClientRef	Your internal reference. The reference will also appear on the invoice next to the project name of your survey.	string	Max length: 80
SurveyFolderId The id of the survey folder in which the survey is located. Type integer
SurveyFolderId	The id of the survey folder in which the survey is located.	integer
Links HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic. Type Hateoas
Links	HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.	Hateoas

Related Methods

Verb	Url	Description
GET - 3/surveys/{surveyId}?lang={lang}&includeQuestions={includeQuestions} Retrieve a survey by id.
GET	3/surveys/{surveyId}?lang={lang}&includeQuestions={includeQuestions}	Retrieve a survey by id.
POST - webhooks/event/Survey/Created Occurs when a new survey is created.
POST	webhooks/event/Survey/Created	Occurs when a new survey is created.
GET - 3/Surveys?lang={lang}&top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}&expand={expand} Retrieve all surveys which match the passed criteria.
GET	3/Surveys?lang={lang}&top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}&expand={expand}	Retrieve all surveys which match the passed criteria.