Skip to main content
GET
Get a participant's quiz result

Authorizations

x-api-key
string
header
required

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

Path Parameters

quizId
string
required

The unique identifier of the quiz

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

"quiz_abc123"

instanceId
string
required

The scheduled-activity id that delivered the quiz to the participant

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

"act_abc123"

userId
string
required

The participant's user id

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

"user_abc123"

Response

The participant's per-question result

object
enum<string>
required
Available options:
quiz_participant_result
quiz_id
string
required
instance_id
string
required
title
string
required
user_id
string
required
display_name
string | null
required
email
string
required
status
enum<string>
required

This participant's status for the quiz run.

Available options:
not_started,
in_progress,
completed,
expired
answered
integer
required
total
integer
required
correct
integer
required
score_pct
integer | null
required

Correct / total questions as a 0-100 percentage. Null when nothing was received.

delivered_at
string | null
required

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

started_at
string | null
required

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

last_activity_at
string | null
required

Most recent answer (ISO 8601). Null if not started.

completed_at
string | null
required

Completion time (ISO 8601). Null if not completed.

due_at
string | null
required

When answers are due / the run expires (ISO 8601). Null if no deadline.

delivery_method
enum<string>
required

How the quiz 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.

questions
object[]
required