Skip to main content
GET
Get track report

Authorizations

x-api-key
string
header
required

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

Path Parameters

track_id
string
required

The unique identifier of the track

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

"i3XJiIJjOp7PJJBTvu4i"

Query Parameters

status
enum<string>
default:all

Filter enrollees or group runs by status (default: all). For group runs, completed matches successful delivered runs.

Available options:
scheduled,
active,
delivered,
completed,
failed,
paused,
canceled,
all
Example:

"all"

start_date
string<date-time>

Filter enrollees or group runs started at or after this date (ISO 8601)

Example:

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

end_date
string<date-time>

Filter enrollees or group runs started at or before this date (ISO 8601)

Example:

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

cohort_id
string

Only enrollees and group runs for this cohort, including people enrolled when the track was sent to it

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

Only this step: its progress on each row, and its variants in step analytics

Example:

"NKqbhqFnRyGChRhvM6bB"

variant_id
string

With step_id: only enrollees who got this variant of that step, and step analytics for them. Use default for the step's own content.

Minimum string length: 1
Example:

"default"

Response

Track report

object
enum<string>
required

Object type identifier

Available options:
track_report
Example:

"track_report"

id
string
required

Track ID

Example:

"i3XJiIJjOp7PJJBTvu4i"

name
string
required

Track name

Example:

"New Hire Onboarding"

state
enum<string>
required

Current track state

Available options:
draft,
active,
paused,
archived
Example:

"active"

trigger_type
enum<string>
required

How users are added to the track

Available options:
user_join,
manual_user_trigger,
manual_group_trigger,
schedule,
schedule_group,
work_anniversary,
added_by_another_track,
self_join,
cohort_started,
cohort_member_added,
mentoring_pair_introduced,
channel_join
Example:

"user_join"

reporting_unit
enum<string>
required

Whether report rows and step analytics represent individual enrollees or subject-less group runs.

Available options:
enrollee,
group_run
summary
object
required

Summary statistics for the report

step_analytics
object[]
required

Per-step aggregate analytics computed from all subjects matching the filter. reporting_unit identifies whether subjects are enrollees or group runs.