Skip to main content
GET
Get track introductions report

Authorizations

x-api-key
string
header
required

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

Query Parameters

track_id
string
required

Filter to introductions from a specific track (workflow). Required.

Example:

"wf_abc123"

step_id
string

Filter to introductions from a specific step within the track. If not provided, includes all introduction steps.

Example:

"step_xyz789"

limit
integer
default:25

Maximum number of matches to return (default: 25, max: 100)

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

25

starting_after
string

Cursor for pagination

Example:

"match_abc123"

ending_before
string

Cursor for pagination (backward)

Example:

"match_xyz789"

from_date
string

Filter matches from this date (ISO 8601)

Example:

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

to_date
string

Filter matches until this date (ISO 8601)

Example:

"2024-12-31T23:59:59.999Z"

Response

Aggregated introduction report for the track

object
enum<string>
required

Object type identifier

Available options:
track_introduction_report
Example:

"track_introduction_report"

track_id
string
required

Track ID that was filtered

Example:

"wf_abc123"

step_id
string | null
required

Step ID that was filtered (null if all steps)

Example:

"step_xyz789"

summary
object
required

Aggregated report summary metrics

matches
object[]
required

Paginated matches with participant details

has_more
boolean
required

Whether there are more matches available beyond this page

Example:

true

url
string
required

The URL for accessing this report

Example:

"/v1/introductions/report?track_id=wf_abc123"

next_cursor
string | null
required

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

Example:

"match_xyz789"

previous_cursor
string | null
required

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

Example:

"match_abc123"