Survey

An object that describes a survey form.

Field nameTypeConditionsDescription
idstringreadabledefault_fieldSurvey identifier
namestringreadablewritablerequiredmax_length=255Survey name
urlstringreadableDirect link to the survey
statusintegerreadablewritable
choices =
  • 1 - Active
  • 2 - Archived
Survey status. Moving an active survey to the archive and back is performed only via special requests. Updates are not available for archived surveys.
createddatetimereadableCreation time
updateddatetimereadableLast update time
respondents_countintegerreadableNumber of respondents collected by the survey
ad_plans_countintegerreadableNumber of ad campaigns in which the survey is used
ad_plan_idslist of uint32readableIDs of ad campaigns in which the survey is used
ad_group_idslist of uint32readableIDs of ad groups in which the survey is used
banner_idslist of uint32readableIDs of ads (banners) in which the survey is used
active_ad_plan_idslist of uint32readableIDs of active ad campaigns in which the survey is used
first_screen_typestringreadablewritablerequired
choices =
  • text
Type of the first survey screen
titlestringreadablewritablerequiredmax_length=50Survey title
descriptionstringreadablewritablemax_length=35Survey description
company_titlestringreadablewritablerequiredmax_length=30Company name
logo_idstringwriteablerequiredCompany logo identifier, returned when you upload a logo
logoobjectreadableCompany logo
gradientintegerreadablewritable
choices =
  • 0 - #FF7583 0%, #E62E40 100%
  • 1 - #FF80D5 0%, #E645B1 100%
  • 2 - #FFD54F 0%, #E7A902 100%
  • 3 - #6CD97E 0%, #12B312 100%
  • 4 - #8AE6E6 0%, #12B3B3 100%
  • 5 - #73D0FF 0%, #3885E1 100%
  • 6 - #FF4D87 0%, #9F40FF 100%
Survey background color. Values from 0 to 6 are gradients.
result_infoSurveyResultInforeadablewriteablerequiredInformation for the final screen of the form
pageslist of SurveyPagereadablewriteablemax_items=24List of survey pages
required_answersbooleanreadablewritableFlag indicating whether questions are required