Query parameters syntax

The query parameters in your post should follow the specific syntax that includes name, value, and format.

Name syntax

The following rules must be followed for the name syntax.

  • Name syntax is case-sensitive.
  • Name syntax is case-sensitive. The post must include name VOCName to be a viewable page in Tealeaf®.
  • Each name should be unique.

You must define which feedback parameters to post to Tealeaf, and then define each name so that they can identify the feedback in Tealeaf.

The following set of Tealeaf pre-defined names can be used where the feedback is appropriate for the customer to take advantage of the set of pre-built Tealeaf templates. This set of pre-defined names are established for feedback commonly included by the customer, and are known as common feedback. Some or all of these Tea-leaf pre-defined names for common feedback can be used as applicable.

You can define names other than those names reserved for common feedback. Customer-defined names are known as custom feedback.

Table 1. Query parameters
Name Value type Description
VOCName This name is required for each post to be a viewable page in Tealeaf.
Comment Unstructured Verbatim feedback for one open-ended question.
Page URL The page from which user came from to provide feedback.
CommentReason String The structured response selection from a customer-defined list of values for the reason why feedback is being provided. Do not use this parameter name for open-end verbatims.
SiteVisitReason String The structured response selection from a customer-defined list of values for the reason for visiting the customer's online site. Do not use this parameter name for open-end verbatims.
SiteVisitReason Success String The structured response selection for boolean type to indicate whether the visitor was successful accomplishing the reason for their visit to the online site.
CSatRating Positive integer While this value can be any integer, pre-defined templates assume a rating scale of 0 to 10 for the customer satisfaction rating.
OverallRating Positive integer While this value can be any integer, pre-defined templates assume a rating scale of 1 to 5 for the overall site rating.
ContentRating Positive integer While this value can be any integer, pre-defined templates assume a rating scale of 1 to 5 for the site content rating.
DesignRating Positive integer While this value can be any integer, pre-defined templates assume a rating scale of 1 to 5 for the site design rating.
UsabilityRating Positive integer While this value can be any integer, pre-defined templates assume a rating scale of 1 to 5 for the site ease-of-use rating.
StatementRating Positive integer While this value can be any integer, pre-defined templates assume a rating scale of 0 to 10 for rating the statement.

Value syntax

The following rules must be followed for the value syntax.
  • Each name should only contain one value.
  • The value might be empty, except for name VOCName.
  • The value for name VOCName should be the identifier for the VOC Vendor

Complete syntax

The following rules must be followed for the complete syntax.
  • The name is separated from the value by =.
  • The name-value pairs should each be separated by &.

Syntax examples

The following example shows name-value pairs in the querystring for common feedback that includes customer satisfaction rating, verbatim feedback for an open-ended question, the page from which user came from to provide feedback, and the reason for visiting the customer's online site.

VOCName=Survey+Now&CSatRating=6&Comment=Your+site+is+confusing+and+hard+to+
find+anything.&Page=http://www.yourwebsite.com/store/&SiteVisitReason=Check
Order+Status

The following example shows name-value pairs in the querystring that contains common feedback and custom feedback. This includes the identifier for the survey type (since the customer uses more than 1 survey from the VOC vendor), the overall site rating, the reason why feedback is being provided, and the verbatim feedback for an open-ended question.

VOCName=Survey+Now&SurveyType=10975&OverallRating=3&CommentReason=Overall+
Experience&Comment=It+takes+too+long+to+complete+a+purchase.+Is+all+this+i
nformation+necessary?

The following example shows name-value pairs in the querystring that contains common feedback and custom feedback. This includes the identifier for the survey type (since the customer uses more than 1 survey from the VOC vendor), the overall site rating, the reason why feedback is being provided, the verbatim feedback for an open-ended question, email address for visitors that want to be contacted, and a would you recommend rating. It contains empty values for the overall site rating and the email address because the visitor did not answer these survey questions.

VOCName=Survey+Now&SurveyType=Guest&OverallRating=&CommentReason=Overall+Ex
erience&Comment=It+takes+too+long+to+complete+a+purchase.+Is+all+this+infor
mation+necessary?&Email=&CSATRating=7