ForeSee Developer Portal

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

Blueprint

Default CPPs

Based on the survey type and SDK version, ForeSee collects certain CPPs by default. This article describes these CPPs in detail.

Email Deployed Surveys

Default CPPs for Email surveys:

  • browser: The brand name and version of browser used by the survey respondent.
  • browser_name: The brand name (only) of browser used by the survey respondent.
  • browser_version: The version (only) of browser used by the survey respondent.
  • eid: System identifier used with email deployed surveys. Set at the time of the initial invitation and is connected to subsequent reminder emails to ensure a survey is not retaken multiple times.
  • sid: A survey identifier generated by the code to represent which survey was presented to the respondent.
  • survey_presentation: Indicates whether a standard template or mobile template was used to present the survey.
  • url: The Uniform Resource Locator (URL) of the page upon which the survey is presented.
  • wurfl_id: The Wireless Universal Resource File (wurfl) is the code that identifies the type of wireless device that allows the system to be configured accordingly.

Web SDK Based Surveys

Starting with Web SDK 19.3.3+, any CPPs can be removed from CX Measurement surveys by request. Default CPPs for Feedback surveys cannot be disabled.

Web SDK Version 19.3.3+

Note: CPPs are sent at the time of survey submission and reflect values captured in the previous 24 hours. Default CPPs for Feedback may be slightly different than for CX Measurement.
  • browser (browser) - The brand name and version of browser used by the survey respondent.
  • Browser name (browser_name) – The brand name (only) of browser used by the survey respondent.
  • Browser Version (browser_version) – The version (only) of browser used by the survey respondent.
  • Web SDK Version (code) - ForeSee code version. This should match the trigger_version CPP once client has upgraded to 19.3.0+.
  • dn (display name) - Used to name invitations, typically passed as value of 'default' if a custom invitation is not used.
  • dt (display template) - Used to identify the template employed for the survey invitation (modern or classic). This started with Web SDK 19.7.0.
  • Environment (env) - Identifies which code snippet is being used; Staging (stg) or Production (prd).
  • Fingerprint (fp) - Anonymous identifier for the survey respondent, used for cookieless tracking in 19.4.0+. (This was phased out in 19.7.0.)
  • language (locale) - The dialect or locale as defined in the survey code.
  • operating system (os) - Type of operating system used by the survey respondent (e.g., Windows, Mac).
  • page views (pv) - The number of site pages visited (technically, it's every page in which our code runs) prior to the survey being presented.
  • referrer (referrer) - The full Uniform Resource Locator (URL) of the site visited PRIOR to coming to the site being measured.
  • Replay ID (replay_id) - A system identifier to represent the user for Replay purposes.
  • Session ID (sessionid) - A system identifier to represent the visit or session.
  • Survey ID (sid) - A system identifier generated by the code to represent the survey presented to the visitor. This id + customer id determines which modelinstanceid (survey) is presented.
  • Site Domain or Site Name (site) - Used to distinguish between multiple domains. In Web SDK 19.5.0+, this is the top level domain the code is placed on. In Web SDK 19.2-19.4 this is the client sitekey.
  • Section (section) - Name of the Section of the page, as defined in the CX Measurement configuration.
  • Site Key (sitekey) - Applies to Web SDK 19.5.0+, this is the client sitekey. (Directory name which is used for file hosting).
  • Survey Presentation (survey_presentation) - Indicates whether a standard template or mobile template was used to present the survey.
  • referring domain search terms (terms) - The words, letters, or phrases entered into the referring domain, if any, e.g., search terms entered into google.com or yahoo.com. (Removed around 19.6.0)
  • Trigger Code Version (trigger_version) - The trigger code version number. This may differ from the 'code' CPP above, depending on what versions of code are being run.
  • url (url) - The Uniform Resource Locator (URL) of the page visited. In the case of a CPP, it's the last page visited prior to survey being presented.
  • wurfl_id (device type id) - The Wireless Universal Resource File (wurfl) is the code that identifies the type of wireless device to allow the system to be configured accordingly.
  • Google Analytics ID (GA_ID) - An alphanumeric character string used by Google Analytics as a tracking code to identify web pages belonging to your account.
  • Adobe Omniture visitor ID (OTR_VID) - For clients using Adobe Omniture. An alphanumeric character string unique to each site visitor and is used, in part, to create an Adobe Omniture beacon.
  • Adobe Omniture beacon (OMTR_BEACON) - For clients using Adobe Omniture. This is created by combining the Adobe Visitor ID, Report Suite ID, and Marketing Cloud ID.
  • Mouseoff Trigger (mouseoff) - Indicates if the invitation was triggered based on detected exit intent (added around 19.6.0).
  • Trigger Method (triggermethod) - Indicates how the invitation was triggered (mouse-off or traditional) (added around 19.6.5).
  • Deployment Type (Deployment_type) - Type of Feedback deployment (URL verses Badge/CustomJS) (added around 19.6.0).
  • Product Type (Product_type) - Indicates the type of SDK (always Web for Web SDK) (added around 19.6.0).
  • Timezone (tz) - Indicates the timezone offset in minutes (e.g., EST is -300) (added around Web 19.6.0).
  • Survey Application (fs renderer) - Indicates the style of the survey questionnaire (values are "legacy" and "modern") (set by the Survey Application).
  • SurveyAppVersion (SurveyAppVersion) - Indicates the version number of the Survey Application Product (set by the Survey Application).
  • Partial Complete Survey (isPartialResponse) - Indicates if the survey was partially completed. (True if all or some required questions are missing, only passed for multi-page surveys) (May be reconfigured soon).
  • True Conversion Report (truConv_event) - This CPP is obsolete and is scheduled to be removed soon. This refers to our older True Conversion product.

Additional CPPs for Mobile Traffic

  • Device (device) - Type of device used by the survey respondent (e.g., 'iPhone', 'Android').
  • Date of initialization (invite_date) - System generated date and time of user email or phone number submission (e.g., '2017-10-27 18:21').
  • Notification method (notification_method) - Indicates if survey link was emailed or sent by text message.

Web SDK Version 19.2.X-19.3.2

Note: CPPs are based on values captured over the previous 90 days.

  • *browser (browser) - The brand name and version of browser used by the survey respondent.
  • Browser name (browser_name) – The brand name (only) of browser used by the survey respondent.
  • Browser Version (browser_version) – The version (only) of browser used by the survey respondent.
  • *Web SDK Version (code) - ForeSee code version. This should match the trigger_version CPP once client has upgraded to 19.3.0+.
  • dn (display name) - Used to name invitations, typically passed as value of 'default' if a custom invitation is not used.
  • Environment (env) - Identifies which code snippet is being used; Staging (stg) or Production (prd).
  • Fingerprint (fp) - Anonymous identifier for the survey respondent, used for cookieless tracking in 19.4.0+.
  • language (locale) - The dialect or locale as defined in the survey code.
  • *operating system (os) - Type of operating system used by site visitor (e.g., Windows, Mac).
  • page views (pv) - The number of site pages visited (technically, this is every page on which ForeSee code runs) prior to the survey being presented.
  • referrer (referrer) - The full Uniform Resource Locator (URL) of the site visited PRIOR to coming to site being measured. May not collect in all cases.
  • Replay ID (replay_id) - A system identifier to represent the survey respondent for Replay purposes.
  • Session ID (sessionid) - A system identifier to represent the visit or session.
  • Survey ID (sid) - A system identifier generated by the code to represent the survey presented to the survey respondent. This id + customer id determines which modelinstanceid (survey) is presented.
  • *Site Domain or Site Name (site) - Used to distinguish between multiple domains.
  • Survey Presentation (survey_presentation) - Indicates whether a standard template or mobile template was used to present the survey.
  • *referring domain search terms (terms) - The words, letters, or phrases entered into the referring domain, if any, e.g., search terms entered into google.com or yahoo.com.
  • Trigger Code Version (trigger_version) - The trigger code version number. This may differ from the 'code' CPP above, depending on what versions of code are being run.
  • url (url) - The Uniform Resource Locator (URL) of the last page visited prior to survey being presented.
  • wurfl_id (device type id) - The Wireless Universal Resource File (wurfl) is the code that identifies the wireless device to allow the system to be configured accordingly.
  • *Google Analytics ID (GA_ID) - For clients using Google Analytics. An alphanumeric character string used by Google Analytics as a tracking code to identify web pages belonging to your account.
  • *Adobe Omniture visitor ID (OTR_VID) - For clients using Adobe Omniture. An alphanumeric character string unique to each site visitor and is used, in part, to create an Adobe Omniture beacon.
  • *Adobe Omniture beacon (OMTR_BEACON) - For clients using Adobe Omniture. This is created by combining the Adobe Visitor ID, Report Suite ID, and Marketing Cloud ID.

*may be removed from the code to reduce cookie size.

Web SDK version 15.x-19.1

  • page views (pv) - The number of site pages visited (technically, it's every page on which ForeSee code runs) prior to the survey being presented.
  • flash version (flash) - The version of Adobe Flash in the survey respondent's browser.
  • language (locale) - The dialect or locale as defined in the survey code.
  • operating system (os) - Type of operating system used by survey respondent (e.g., Windows, Mac).
  • *referring domain (referrer) - The domain name, e.g., google.com or yahoo.com, of the site visited PRIOR to coming to site being measured.
  • *referring URL (ref_url) - The full Uniform Resource Locator (URL) of the site visited PRIOR to coming to site being measured.
  • *referring domain search terms (terms) - The words, letters, or phrases entered into the referring domain, if any, e.g., search terms entered into google.com or yahoo.com.
  • Session ID (sessionid) - A system identifier to represent the visit or session.
  • Survey Definition (sid) - The name of the survey presented to the survey respondent as defined in the code. This is useful to clients using multiple surveys on the same site.
  • Site Domain or Site Name (site) - Used to distinguish between multiple domains.
  • Survey ID (survey ID) - A system identifier generated by the code to represent the survey presented to the survey respondent. This id + customer id determines which modelinstanceid (survey) is presented.
  • Trigger Code Version (trigger_version) - The trigger code version number. This may differ from the 'code' CPP above, depending on what versions of code are being run.
  • *url (url) - The Uniform Resource Locator (URL) of the last page visited prior to survey being presented.
  • browser (browser) - The brand name and version of browser used by the survey respondent.
  • browser_name – The brand name (only) of browser used by the survey respondent.
  • browser_version – The version (only) of browser used by the survey respondent.

*may be removed from the code to reduce cookie size.

Depending on Device:

  • dual_orientation – For a mobile device with orientation change, this indicates if the survey respondent visited the site in landscape or portrait mode.
  • is_tablet – Indicates whether the device is a Tablet or not (true, false).
  • pointing_method - Identifies the method used to interact with the user interface, e.g., touchscreen, mouse, etc.
  • wurfl_id (device type id) - The Wireless Universal Resource File (wurfl) is the code that identifies the wireless device to allow the system to be configured accordingly.
  • os - The brand name and version of the operating system used by the survey respondent.
  • os_name - The brand name (only) of operating system used by the survey respondent (e.g., iOS, Android).
  • os_version - The version (only) of the operating system used by the survey respondent.
  • resolution - The screen resolution (width by height) of the device used by the survey respondent.
  • resolution_height - The height only of the screen resolution, i.e., the number of lines on the screen.
  • resolution_width - The width only of the screen resolution, i.e., the number of pixels per line.
  • screen - The screen size in millimeters (width by height) of the device used by the survey respondent.
  • screen_height - The height (only) of the screen size in millimeters of the device used by the survey respondent.
  • screen_width - The width (only) of the screen size in millimeters of the device used by the survey respondent.
  • model_name - The device model, as assigned by the manufacture, derived from the Wireless Universal Resource File (see wurfl-id above).
  • brand_name - The brand name of the device used by the survey respondent.
  • survey_presentation - Indicates whether a standard template or mobile template was used to present the survey.

Updated 3 months ago

Default CPPs


Suggested Edits are limited on API Reference Pages

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