ForeSee Developer Portal

Everything you need to set up and optimize your ForeSee product. Home of developer documentation, implementation guides, and question/answer forums.

Blueprint

ForeSee URL API

The URL API is used to for static links, such as those in emails or in feedback solutions, to trigger a ForeSee survey. Client Services may refer to this feature as the Survey Link or the Email Link.

Only some CPPs are collected automatically when the URL API is used:

  • sid
  • survey_time
  • survey_submits
  • Allows multiple presentations and submissions in same session
  • No fsr.r cookie is dropped.
  • May append additional CPPs using API syntax (see Adding Additional CPPs below)

API Syntax

ForeSee uses the following parameters to build the URL API:

  • cid: Customer Identifier provided by ForeSee
  • sid: Survey Identifier provided by ForeSee

Example Format:

http://survey.foreseeresults.com/survey/display?cid=[CID]&sid=[SID]

Working Example:

http://survey.foreseeresults.com/survey/display?cid=8NNxB5BIVJdMBEBUBJ1Fpg==&sid=link

Adding Additional CPPs

Use these guidelines when you need to pass Customer Passed Parameters (CPPs) using the URL API.

You can determine which parameters (limit 2056 characters for total URL string) are to pass along with the submitted survey. Multiple CPPs are delimited by an ampersand (&).

Example:
ForeSee provides the email survey link in following general format:

http://survey.foreseeresults.com/survey/display?cid=[cid]&sid=[sid]

There is a CPP to pass with the survey, such as CustID – Client Specific Customer Identifier (The name/value assignment format: &cpp[name]=value). You should append the CPP format to the end of the string like so:

http://survey.foreseeresults.com/survey/display?cid=[]&sid=[]&cpp[custid]=1234

Working example:

http://survey.foreseeresults.com/survey/display?cid=8NNxB5BIVJdMBEBUBJ1Fpg==&sid=link&cpp[custid]=1234

Send a test submission

If you would like to send a test to make sure ForeSee receives your parameter, you must select “Don’t Know” for the first set of questions and submit the survey. Then, you must contact your Implementation Consultant (if launching a new measure) or Support (if checking on an existing measure).

ForeSee URL API