Template variables > Response

Response template variables are passed through to your template when a respondent is taking your survey. This page details the structure of those template variables so you can know what to expect when designing your templates.

survey.response.
   id
   number
   url
   url_resume
   url_complete
   accepted
   complete
   preview
   startedon
   completedon
   lastmodifiedon
   ip
   country
   email
   email_verified
   closed
   timedout
   scored
   score
   scoremax
   cq
   fm

   language.
      id
      name
      direction

   loops[]
      # Variables for each loop in survey.response.loops[]
      id
      qid
      aid
      count

   invitation.
      id
      url
      createdon
      lastemailedon

      dataset.
         id
         name
         type
         idcolumn

         columns[]
            # Variables for each column in survey.response.invitation.dataset.columns
            id
            name
            type
            insummary
            ishtml

         record.
            # Additional variables depend on survey.response.invitation.dataset.type
            Address Book Record template variables
            Custom Table Record template variables

[edit] survey.response.accepted

This field will be set to 1 once the survey response has been accepted and charged to your account. If this response is still pending, this field will be 0.

[edit] survey.response.scored

This is set to 1 if the response has been scored. Otherwise, it will be set to 0. This can differ from survey.publication.scoring if a response was taken prior to a change in the publication scoring behavior. If this field is set to 1, then both survey.response.score and survey.response.scoremax will also be available.

[edit] survey.response.score

This is the score that the respondent received for their response. This variable is only available if survey.response.scored is set to 1.

[edit] survey.response.scoremax

This is the maximum score possible, either automatically calculated, or as specified in the survey or publication. This variable is only available if survey.response.scored is set to 1.

[edit] survey.response.invitation.

[edit] survey.response.invitation.id

[edit] survey.response.invitation.dataset.

[edit] survey.response.invitation.dataset.type

This variable identifies the type of data set that the current invitation came from. survey.response.invitation.dataset.type will be set to:

'AddressBook' for Address Book data sets
'CustomTable' for Custom Table data sets

[edit] survey.response.invitation.dataset.columns[]

[edit] column.id

[edit] column.name

[edit] column.type

[edit] column.insummary

[edit] column.ishtml

[edit] survey.response.invitation.dataset.record.