Surveys

Returns a specific survey with the provided ID.

get

/surveys/{survey_id}

Path parameters

survey_idnumberrequired

The survey's unique identifier.

Query parameters

identifierstringrequired

The account's unique ID.

Example: PI-1234567890

device_typestring · enumrequired

The type of device that's requesting the survey/poll. Use 'desktop' if unsure.

Options: desktop, mobile, tablet, native_mobile, email

callbackstring

Conditionally required. If device_type != 'native_mobile' OR 'email'. Response will be wrapped in callback code. For example, passing "console.debug" will result in "console.debug('{}')".

Example: console.debug

custom_datastring

Also known as "Context Data". Used to specify context in which the survey appeared. See https://docs.pulseinsights.com/implementing-pulse-insights-dev/implementing-on-web-and-mobile-web/ingesting-contextual-data-for-targeting-and-analysis#context-data for more details.

preview_modestring

If 'true' then nothing will be recorded in the database.

Example: true

visit_countnumber

The number of times the user has visited the site. Used to target surveys.

pageview_countnumber

The number of times the user has visited the page. Used to target surveys.

udidstringrequired

The device's unique ID.

Example: 00000000-0000-4000-f000-000000000001

urlstring

The URL from which the submission was made. If not provided HTTP_REFERER will be used as a fallback.

Responses

application/javascript

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://survey.pulseinsights.com/surveys/{survey_id}?identifier=PI-1234567890&device_type=desktop&udid=00000000-0000-4000-f000-000000000001'

200

200

{}

Successful response. Will return empty object if no eligible surveys are found. Otherwise the return type is based on the "device_type" parameter. (native_mobile, email, all others).

Retrieves a survey by its event name.

get

/surveys/{event_name}

Path parameters

event_namestringrequired

The name of the event identifying the survey.

Query parameters

identifierstringrequired

The account's unique ID.

Example: PI-1234567890

device_typestring · enumrequired

The type of device that's requesting the survey/poll. Use 'desktop' if unsure.

Options: desktop, mobile, tablet, native_mobile, email

callbackstring

Conditionally required. If device_type != 'native_mobile' OR 'email'. Response will be wrapped in callback code. For example, passing "console.debug" will result in "console.debug('{}')".

Example: console.debug

custom_datastring

Also known as "Context Data". Used to specify context in which the survey appeared. See https://docs.pulseinsights.com/implementing-pulse-insights-dev/implementing-on-web-and-mobile-web/ingesting-contextual-data-for-targeting-and-analysis#context-data for more details.

preview_modestring

If 'true' then nothing will be recorded in the database.

Example: true

visit_countnumber

The number of times the user has visited the site. Used to target surveys.

pageview_countnumber

The number of times the user has visited the page. Used to target surveys.

udidstringrequired

The device's unique ID.

Example: 00000000-0000-4000-f000-000000000001

urlstring

The URL from which the submission was made. If not provided HTTP_REFERER will be used as a fallback.

Responses

application/javascript

text/plain

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://survey.pulseinsights.com/surveys/{event_name}?identifier=PI-1234567890&device_type=desktop&udid=00000000-0000-4000-f000-000000000001'

200

404

200

{}

Successful response. Will return empty object if no eligible surveys are found. Otherwise the return type is based on the "device_type" parameter. (native_mobile, email, all others).