Capture Parameters

Learn how to track extra information via query parameters

Developers avatar
Written by Developers
Updated over a week ago

Capture Parameters is a feature that allows you to track data about the stakeholders who engage with your projects. It passes data from the stakeholder's URL to any responses that are created by that stakeholder.

Contact your account admin to get access to Capture Parameters

Setting Up Capture Parameters

Create capture parameters, and add those parameters to links that are sent to stakeholders. Once those stakeholders leave a response you will be able to see the values of the capture parameters associated to the response.

  1. Go to /admin/capture_parameters or click Sites > Capture Parameters

  2. Click New Capture Parameter

  3. Setup the capture parameter

    1. Name (required) - a name for the capture parameter, this will be used for reporting purposes

    2. Key (required) - this is the key that will be used in the URL

    3. Description - an optional description for administration purposes

    4. Enabled - this allows you to disable/enable capture parameters

  4. Click Create Capture Parameter

Edit screen for a capture parameter

Using Capture Parameters in your links

It is up to you how you want to leverage capture parameters. In order to start collecting them and associating to responses you will need to add the capture parameter to the URL as a Query String

For example, you might create a capture parameter that is used to identify the source of a stakeholder. Let's say you create a capture parameter called Source with the key source. You could send an email to a group of stakeholders with a link like so:

Where ?source=email is the query string. Social Pinpoint will "capture" this value and associate it to any responses that the stakeholder makes after they follow the provided link.

A query string will look like this:


Where the first parameter follows a question mark (?) and subsequent parameters are separated by an ampersand (&)

How are capture parameters stored?

We store the values extracted from the URL in session storage, so the values captured will persist between page loads, and the stakeholder navigating to pages without a query string appended to the URL. These values will persist until overwritten by another query string with the same key, or the stakeholder clears their session storage on their end.

Once a response has been created the value of the parameter is persisted, and will remain static regardless of what happens in the user session.

Viewing Captured Parameters

Capture parameters are associated to responses, which include:


  2. Survey Responses

  3. Budget Responses

To see the values that have been associated to a response you can view them in any of the following ways:

  1. Via the Responses screen

  2. Via CSV export

  3. Via the V1 API

Response Table

You will be able to see the capture parameters for a response via the Responses Table. These will appear under the Capture Parameters column where you can filter and sort based on the name of the captured parameters.

You can also view this information for an individual response.

CSV Exports

This information is also available in the CSV exports that can be generated from the response screen. Each capture parameter will appear as its own column.


Capture parameters are exposed via our public-facing API.

Did this answer your question?