Poll

Submits an answer to a survey question in an e-mail.

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

Path parameters

survey_id*string

The survey's unique ID.

Query parameters

Response

Successful response.

Body

surveySurvey (object)

A survey object.

questionobject

resultsPollResults (object)

Request

const response = await fetch('https://survey.pulseinsights.com/surveys/{survey_id}/poll?identifier=PI-1234567890&device_type=desktop&question_id=0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "survey": {
    "id": 0,
    "name": "Fall Customer Engagement Survey",
    "survey_type": 0,
    "invitation": "Would you like to take a survey?",
    "top_position": "10px. 25%",
    "bottom_position": "10px. 25%",
    "left_position": "10px. 25%",
    "right_position": "10px. 25%",
    "width": 300,
    "background_color": "#ff00aa",
    "text_color": "#ff00aa",
    "inline_target_selector": "#survey_container",
    "thank_you": "Would you like to take a survey?",
    "answer_text_color": "#ff00aa",
    "mobile_inline_target_selector": "#mobile_survey_container",
    "sdk_inline_target_selector": "#sdk_survey_container",
    "display_all_questions": "t",
    "fullscreen_margin": 42,
    "invitation_button": "Click here to get started",
    "invitation_button_disabled": "t",
    "single_page": false,
    "ignore_frequency_cap": false,
    "randomize_question_order": "t",
    "all_at_once_empty_error_enabled": "t",
    "all_at_once_submit_label": "Submit",
    "all_at_once_error_text": "Please fill answers",
    "survey_locale_group_id": 0,
    "personal_data_masking_enabled": "t",
    "phone_number_masked": "t",
    "email_masked": "t",
    "background": "https://cdn.pulseinsights.com/background/survey/:survey_id/:background_image_url",
    "pulse_insights_branding": false,
    "custom_data_snippet": "text",
    "onclose_callback_code": "text",
    "oncomplete_callback_code": "text",
    "onanswer_callback_code": "text",
    "onview_callback_code": "text",
    "onclick_callback_code": "text",
    "intersection_observer_enabled": "t",
    "inline_target_position": 0,
    "theme_css": "text"
  },
  "question": {
    "id": 0,
    "question_type": 0,
    "content": "text",
    "question_locale_group_id": 0
  },
  "results": {
    "poll": [
      {
        "id": 0,
        "content": "text",
        "count": 0
      }
    ],
    "content": "text",
    "question_type": 0,
    "answers_via_checkbox": [
      [
        "12",
        "42"
      ]
    ]
  }
}

PreviousQuestions NextQ

Last updated 9 months ago

const response = await fetch('https://survey.pulseinsights.com/surveys/{survey_id}/poll?identifier=PI-1234567890&device_type=desktop&question_id=0', { method: 'GET', headers: {}, }); const data = await response.json();

{ "survey": { "id": 0, "name": "Fall Customer Engagement Survey", "survey_type": 0, "invitation": "Would you like to take a survey?", "top_position": "10px. 25%", "bottom_position": "10px. 25%", "left_position": "10px. 25%", "right_position": "10px. 25%", "width": 300, "background_color": "#ff00aa", "text_color": "#ff00aa", "inline_target_selector": "#survey_container", "thank_you": "Would you like to take a survey?", "answer_text_color": "#ff00aa", "mobile_inline_target_selector": "#mobile_survey_container", "sdk_inline_target_selector": "#sdk_survey_container", "display_all_questions": "t", "fullscreen_margin": 42, "invitation_button": "Click here to get started", "invitation_button_disabled": "t", "single_page": false, "ignore_frequency_cap": false, "randomize_question_order": "t", "all_at_once_empty_error_enabled": "t", "all_at_once_submit_label": "Submit", "all_at_once_error_text": "Please fill answers", "survey_locale_group_id": 0, "personal_data_masking_enabled": "t", "phone_number_masked": "t", "email_masked": "t", "background": "https://cdn.pulseinsights.com/background/survey/:survey_id/:background_image_url", "pulse_insights_branding": false, "custom_data_snippet": "text", "onclose_callback_code": "text", "oncomplete_callback_code": "text", "onanswer_callback_code": "text", "onview_callback_code": "text", "onclick_callback_code": "text", "intersection_observer_enabled": "t", "inline_target_position": 0, "theme_css": "text" }, "question": { "id": 0, "question_type": 0, "content": "text", "question_locale_group_id": 0 }, "results": { "poll": [ { "id": 0, "content": "text", "count": 0 } ], "content": "text", "question_type": 0, "answers_via_checkbox": [ [ "12", "42" ] ] } }