ForeSee Developer Portal

Everything you need to configure and optimize your ForeSee products. Home of developer documentation, implementation guides, and release notes.

Blueprint

Providing Your Data to ForeSee

Types of Data That Can Be Sent

In addition to collecting survey data, you can include a variety of informative data points about
respondents. This can consist of browsing data like search history, or which products or pages were visited. You can also provide data from other systems such as a visitor I.D., purchases amounts, or respondent location. Some of the benefits of adding this data can be the ability to better segment respondents, as well as augmenting ForeSee data, i.e., data collected by ForeSee products, along with other data.

The two mechanisms for collecting this data are Customer Passed Parameters (CPPs) and Externally Passed Parameters (EPPs). CPPs collect data that is available at the time of a survey submission and EPPs collect data that is passed after the survey has been completed.

Custom Passed Parameters

A CPP is a data point created by, or currently available on, your website and is sent along with a survey submission. CPPs provide additional data for analysis without increasing the number of questions asked on the survey.

What can be sent?

  • Cookie values – For example, a cookie indicating a visitor has logged on to the site.
  • Variable values – For example, a purchase order number set in a variable.
  • URL parameters – For example, the number of items the visitor has in their cart: http://www.mysite.com/?**cartcount=3**.
  • Name:value pairs (created from URL) - For example, for this page URL, http://www.mysite.com/food/, /food/ is a CPP called food_section with a value of “Yes”.
  • Custom – Using the ForeSee CPP API method, which is a line of JavaScript you insert into your web page, you may pass any name:value pair.

There is no limit to the number of data points you can collect. However, this data is stored in a cookie that increases in file size with each added parameter.

CPP Deployment Types

The following survey deployment options support the capture of CPPs:

  • Web survey
  • Static Link – In an email, on a web site, social media, or a URL from signage, store receipt, etc.
  • Interactive Voice Response (IVR) or Intelligent Voice Automation (IVA)
  • Panel Studies – A survey is presented by a third party provider.

Standard CPPs

A list of default CPPs for web surveys can be found here Default CPPs. CPPs can also be eliminated to reduce cookie size, as described in the article on Reducing Cookie Size.

Custom CPPs

Custom CPPs can be added to the data collection process by adding a code snippet to any page containing the ForeSee Embed snippet. For details on adding CPPs for web surveys, refer the the Customer Passed Parameters article. To add CPPs to a static link, refer to the ForeSee URL API article.

Externally Passed Parameters

External Passed Parameters are data points sent to ForeSee in a delimited file (such as Comma Separated Values) to append to survey response data. In contrast to CPPs, which load data at the time the survey is submitted, EPPs are loaded after submission. Use of an external file to pass parameters is often necessary with specific types of deployment and the limitations of your system with regards to passing data to ForeSee. EPP data is loaded once per day.

CSV File Transfer

A Comma Separated Values (CSV) file can be used to transfer data with the following requirements:

  • The file must have column headers.
  • The file must be in a delimited format with associated header record.
  • Dates must be in MM/DD/YYYY or MM/DD/YYYY H:MM format.
  • One row per respondent.
  • The ForeSee Respondent Identifier (respondentId) must exist as a data point in each row.

Email Survey

ForeSee has two methods of supporting surveys that are emailed to survey prospects. ForeSee can send the email and append the additional EPP data as a survey response is submitted. You, the client, may also send the email with the provision that ForeSee is allowed to load the email prior to the email being sent to the survey prospect. This requires a confirmation that the email has been loaded before the email can be sent.

Each EPP is appended as an additional column of data and must have a hidden custom question created. This hidden custom question is used as a container for the data. The column label must match this hidden question label in order to append properly. This is performed by the Delivery Operations Team (DOT) and Implementation Services (IS).

If you are sending the emails, the following options are available for collecting this additional data:

  1. Your email contains a link that corresponds with the link that would ordinarily be created by ForeSee when sending the email.
  2. You can use the CPP syntax previously mentioned to append the CPPs in the URL API.
    **Note:** In most cases, Adobe (Omniture) or Google (UA) integration is accommodated through an API which these companies provide. When using this API, data file transfers are not necessary to deliver ForeSee data to Adobe or Google. More details can be found in the guide to [Analytics Integrations](doc:analytics-integrations).

Updated about a year ago

Providing Your Data to ForeSee


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.