Surveys

Returns a specific survey with the provided ID.

GEThttps://survey.pulseinsights.com/surveys/{survey_id}

Path parameters

survey_id*number

The survey's unique identifier.

Query parameters

Response

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

Body

application/javascript

one of

EmptyObject (string)ServedSurvey (object)

Request

JavaScriptCurlPython

const response = await fetch('https://survey.pulseinsights.com/surveys/{survey_id}?identifier=PI-1234567890&device_type=desktop&udid=00000000-0000-4000-f000-000000000001', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{}

Retrieves a survey by its event name.

GEThttps://survey.pulseinsights.com/surveys/{event_name}

Path parameters

event_name*string

The name of the event identifying the survey.

Query parameters

Response

200404

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

Body

application/javascript

one of

EmptyObject (string)ServedSurvey (object)

Request

JavaScriptCurlPython

const response = await fetch('https://survey.pulseinsights.com/surveys/{event_name}?identifier=PI-1234567890&device_type=desktop&udid=00000000-0000-4000-f000-000000000001', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{}