Skip to main content
GET
Get introduction report

Authorizations

x-api-key
string
header
required

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

Path Parameters

introductionId
string
required

Introduction ID

Example:

"intro_abc123"

Query Parameters

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"

instance_id
string

Filter to a specific instance

Example:

"inst_abc123"

Response

Introduction report with summary and matches

object
enum<string>
required

Object type identifier

Available options:
introduction_report
Example:

"introduction_report"

id
string
required

Introduction ID

Example:

"intro_abc123"

type
enum<string>
required

Introduction type

Available options:
group,
individual
Example:

"group"

summary
object
required

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/intro_abc123/report"

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"