Pulse Insights Documentation
  • Pulse Insights Overview
    • đź‘‹Welcome to Pulse Insights
  • Implementing Pulse Insights (Dev)
    • Implementing on Web and Mobile Web
      • Deploying your tag (code snippet)
      • Ingesting contextual data for targeting and analysis
      • Client Key
      • Tracking Events (aka High Value Actions)
      • Presenting a specific survey
      • Supporting Inline surveys
      • Callbacks
      • Privacy Features
        • Identifiers, cookies, and local storage
        • Data that Pulse Insights stores
      • QA Process and Preview Mode
        • JavaScript Object
      • Single Page Apps
      • Load Time & Availability
      • Bot blocking
      • Customer-initiated Feedback
    • Implementing in email
      • Dynamic Email
    • Implementing in Native Apps
      • Android
        • Android Release Notes
        • Android Demo App
      • iOS
        • iOS Release Notes
        • iOS Demo App
      • Demo App Help
  • Integrations
    • Integrations overview
      • Hubspot
      • Braze
      • Google Analytics
      • Data Lake
  • Configuring Pulse Insights (Console)
    • Account Setup
      • Authentication & SSO
      • Inviting Collaborators
      • Roles & permissions
    • Dashboard & Program Management
      • Survey Status
    • Editor
      • Question Types
        • Survey Invitation
        • Single Choice
          • Using Images
        • Multiple Choice
        • Free Text
        • Net Promoter Score
        • Slider
        • Custom Content (Next Best Action)
        • Thank You Message
          • Poll (Show Results)
      • General
      • Targeting
        • Devices & Channels
        • Sample Rate
        • URL & Events
        • Dates
        • Previous Responses
        • On Page Behavior
        • CRM Targeting
        • Geo Targeting
        • Goal
        • User Behavior
        • Advanced Settings
      • Formatting
        • Widget Types
          • Docked
          • Bottom Bar
          • Top Bar
          • Overlay
          • Inline
        • Themes
        • Question Display
        • Custom CSS (Survey-level)
        • Supported Markdown
      • Link Builder
      • Preview
      • Survey Groups (Localization)
    • Reporting
      • Results Page & Filtering
      • On Demand
        • Columns/Data Dictionary
      • Scheduled Reports
      • Free Text
        • AI Generated Summary
        • Responses & Tagging
      • Custom Content Reporting
      • Viewable Impressions
    • Account Level Settings
      • Get Code Snippet
      • Global Targeting
      • Data & Integrations (Callbacks)
      • Data Restrictions
      • Themes
      • Automations
        • High Value Actions (Events)
      • Activity Log
      • Configured by Pulse Insights
  • Best Practices
    • Best Practices
      • Copy
      • Design and Execution
      • Targeting
      • Widget Types
      • Sample Rate
      • Submission Rates
      • Special Features
      • Best Practices for Progressive Profiling
  • API
    • API reference
      • Surveys
        • Questions
        • Poll
      • Q
        • A
      • Direct serve
      • Serve
      • Results
      • Present results
      • Track event
      • Custom content link click
      • Submissions
        • All answers
        • Answer
        • Close
        • Viewed at
      • Devices
        • Set data
Powered by GitBook
On this page
  • Capturing Free Text Responses
  • Redirecting The User To Another Page Post-Submit
  • Saving Custom Data with Responses Via API
  • Testing Surveys In Draft Mode Via API
  • Showing Poll Results From Poll In-Email
  • Pro Tips:

Was this helpful?

  1. Configuring Pulse Insights (Console)
  2. Editor

Link Builder

PreviousSupported MarkdownNextPreview

Last updated 1 year ago

Was this helpful?

For situations where you can’t use the Pulse Insights code snippet to render surveys and collect data, you can use the Pulse Insights Survey Response API instead.

Pulse Insights integrates into email by placing clickthrough links that record the appropriate response along with other data such as the recipient’s userID. Then optionally, you can redirect the user to a page of your choice. If the page has a Pulse Insights tag, you can optionally collect additional information or just display a Thank You message that the response has been received.

The easiest way to get links is to create the survey/poll in the Console and then use the Link Builder tab to copy the clickthrough URLs.

While in the survey's Editor or Results page, click on the "Link Builder" tab at the top of the page.

Survey responses are passed in the following format: ‍

//survey.pulseinsights.com/q/[question ID]/a/[answer ID]?identifier=PI-XXXXXXXX 
For example:
//survey.pulseinsights.com/q/1234/a/9876?identifier=PI-99999999

Capturing Free Text Responses

You can use the text= parameter to capture free text responses.

Free Text Example:
//survey.pulseinsights.com/q/9999?identifier=PI-81960884&text=this%20is%20a%20response 

Redirecting The User To Another Page Post-Submit

Use the redirect parameter if you want to configure a custom redirect URL. By default, it will redirect to the referrer if there’s any, otherwise, it will just display a thank you message.

Redirect Example:
//survey.pulseinsights.com/q/1234/a/9876?identifier=PI-99999999&redirect=https%3A%2F%2Fyoursite.com

Note: special characters should be encoded in the redirect so portion of the URL as shown above.

To Configure: Click "Settings", then "Global Targeting", scroll to "Redirect Domain Whitelist" and enter the domain(s), 1 per line. Click "Update" to save.

Saving Custom Data with Responses Via API

Any other query string parameter will be saved as custom data within Pulse Insights. This is often used to store things like:

  • The recipients userID so you can tie responses back to an individual

  • Details of the email campaign such as name, campaign date, or whether it’s a test or production email drop.

Custom Data Example:
//survey.pulseinsights.com/q/1234/a/9876?identifier=PI-99999999&userID=5555&locale=us 

Testing Surveys In Draft Mode Via API

You can use preview_mode=true if you want to test draft surveys. //survey.pulseinsights.com/q/1665/a/9163?identifier=PI-81960852&preview_mode=true

Note: Expired or Paused surveys won’t be able to collect data via API and will show an error message if attempted.

Showing Poll Results From Poll In-Email

If you’re asking a question in-email and want to show the results upon answering, you can append: pi_poll=true to the URL.

This will force Pulse Insights to show poll results for the question.

Note: polls results only work for the first single choice question within a survey.

Pro Tips:

  • If a survey/poll is only intended for email, make sure that the targeting is configured to prevent firing on web or mobile.

  • You can append pi_present=[thank you message ID] in the redirect URL to force a thank you message or follow-up questions to appear on click.

The domain of the redirect URL must be whitelisted. This is configured in the Console's .

Global Targeting