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

introduction_id
string
required

Introduction ID

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

"H45xq8UBtUJxmSs294Gu"

Query Parameters

start_date
string<date-time>

Filter matches from this date (ISO 8601)

Example:

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

end_date
string<date-time>

Filter matches until this date (ISO 8601)

Example:

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

instance_id
string

Filter to a specific instance

Example:

"K2CC1FIYz0JGcnCsNbIa"

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:

"H45xq8UBtUJxmSs294Gu"

type
enum<string>
required

Introduction type

Available options:
group,
individual
Example:

"group"

summary
object
required

Report summary metrics