Skip to main content
GET
Get survey report

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

Minimum string length: 1
Example:

"survey_abc123"

Query Parameters

limit
integer
default:25

Maximum number of participants to return (1-250, default 25)

Required range: 1 <= x <= 250
Example:

25

starting_after
string

Cursor for pagination - the ID of the last participant from the previous page

Example:

"user_abc123"

ending_before
string

Cursor for pagination - the ID of the first participant from the next page (for backward pagination)

Example:

"user_xyz789"

from_date
string

Filter participants by received_at >= this date (ISO 8601 format)

Example:

"2026-01-01T00:00:00.000Z"

to_date
string

Filter participants by received_at <= this date (ISO 8601 format)

Example:

"2026-01-31T23:59:59.999Z"

participant_status
enum<string>
default:responded

Filter participants by status: 'responded' (default), 'not_responded', 'all', or 'none' (analytics only, skip participant list)

Available options:
all,
responded,
not_responded,
none
Example:

"responded"

instance_id
string

Filter to a specific delivery instance by ID. When set, from_date and to_date are ignored.

Example:

"inst_abc123"

track_id
string

Filter results to participants from a specific track (workflow). When specified, only participants who received the survey via this track will be included.

Example:

"wf_abc123"

include_comments
enum<string>
default:true

Include comments on questions in the report (default true)

Available options:
true,
false
Example:

"true"

Response

Survey report with analytics and participants

object
enum<string>
required

Object type identifier

Available options:
survey_report
Example:

"survey_report"

id
string
required

Survey ID

Example:

"survey_abc123"

title
string
required

Survey title

Example:

"Employee Satisfaction Survey"

mode
enum<string>
required

Survey mode

Available options:
poll,
survey
Example:

"survey"

response_type
enum<string>
required

How responses are collected

Available options:
anonymous,
user
Example:

"anonymous"

summary
object
required

Summary statistics for the report

questions
object[]
required

Per-question analytics (average scores, answer breakdowns, eNPS)

total_participants
integer
required

Total number of participants matching the filter (for pagination progress)

Example:

180

has_more
boolean
required

Whether there are more participants available beyond this page

Example:

false

url
string
required

The URL for accessing this report

Example:

"/v1/surveys/survey_abc123/report"

next_cursor
string | null
required

Cursor to fetch the next page of participants. Pass as starting_after in subsequent requests.

Example:

"part_xyz789"

previous_cursor
string | null
required

Cursor to fetch the previous page of participants. Pass as ending_before in subsequent requests.

Example:

"part_abc123"

participants
object[]

Paginated list of participants with their answers (based on participant_status)

warning
string

Warning message for large datasets without date filters

Example:

"Large dataset: consider using from_date/to_date filters for better performance"