Skip to main content
GET
Get a respondent's survey result

Authorizations

x-api-key
string
header
required

API key for authentication. Generate keys in the Doozy dashboard.

Path Parameters

surveyId
string
required

The unique identifier of the survey

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
Example:

"survey_abc123"

instanceId
string
required

The survey_instances id that delivered the survey

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
Example:

"inst_abc123"

userId
string
required

The respondent's user id

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
Example:

"user_abc123"

Response

The respondent's answers

object
enum<string>
required
Available options:
survey_participant_result
survey_id
string
required
instance_id
string
required
title
string
required
mode
enum<string>
required
Available options:
poll,
survey
response_type
enum<string>
required
Available options:
anonymous,
user
user_id
string
required
display_name
string | null
required
email
string
required
answered
integer
required
total
integer
required
status
enum<string>
required
Available options:
completed,
in_progress,
not_responded
responded_at
string | null
required
delivered_at
string | null
required

When the survey was delivered to this participant (ISO 8601).

started_at
string | null
required

First response (ISO 8601). Null if not started.

last_activity_at
string | null
required

Most recent response activity (ISO 8601).

closes_at
string | null
required

When the survey closes (ISO 8601). Null if open-ended.

delivery_method
enum<string>
required

How the survey was delivered to this participant.

Available options:
one_off,
track
track_id
string | null
required

Track (workflow) ID if delivered via a track.

track_name
string | null
required

Track (workflow) name if delivered via a track.

answers
object[]
required