Direct serve

Returns the first eligible survey along with its questions and possible answers. One of client_key and udid is required.

get

/direct_serve

Query parameters

identifierstringrequired

The account's unique ID.

Example: PI-1234567890

client_keystring

Used to identify a user across devices and advanced survey targeting. See https://docs.pulseinsights.com/implementing-pulse-insights-dev/implementing-on-web-and-mobile-web/client-key for more details.

udidstringrequired

The device's unique ID.

Example: 00000000-0000-4000-f000-000000000001

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

Responses

application/javascript

text/plain

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://survey.pulseinsights.com/direct_serve?identifier=PI-1234567890&udid=00000000-0000-4000-f000-000000000001'

200

400

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).