Embedded Surveys

Embedded surveys collect structured responses and actions from users.

The response to an embedded survey action may contain a survey selected for the action.

Field	Type	Description
survey?	object	The survey selected for the action, if any

An embedded survey response identifies a submitted response.

Field	Type	Description
responseId	string	The ID of the submitted survey response

{
  "responseId": "R_4Qh72VfJwE8p1sD"
}

Endpoints

POST/users/@me/embedded-surveys/{survey.id}/responses

Submits answers to an embedded survey. Returns an embedded survey response object on success.

Field	Type	Description
values_json	string	A JSON-encoded object mapping question IDs and survey-provider field IDs to their submitted values

{
  "values_json": "{\"QID1\":2,\"QID2\":[\"1\",\"3\"],\"QID2_DO\":[\"1\",\"2\",\"3\"]}"
}

POST/users/@me/embedded-survey/action

Records an action that may select an embedded survey. Returns an embedded survey action response object on success.

Field	Type	Description
action_type	string	The type of action being recorded
metadata?	object	Metadata associated with the action

Value	Description
nitro_unsubbed	A Nitro subscription was ended
checkpoint_completed	A checkpoint was completed
quest_completed	A Quest was completed
ad_impression_quest_bar_opt_in	The Quest bar ad-impression option was enabled
ad_impression_quest_bar_opt_out	The Quest bar ad-impression option was disabled
bounty_session_completed	A bounty session was completed
bounty_immediate_dismissal	A bounty was immediately dismissed
bounty_abandoned	A bounty was abandoned
hangout_window_set	A hangout window was set
populated_clip_gallery_closed	A populated clip gallery was closed
topical_navigation_multiple_impressions	Multiple topical-navigation impressions occurred
guild_room_joined	A guild room was joined

{
  "action_type": "quest_completed",
  "metadata": {
    "quest_id": "1248385850925256704"
  }
}