Schemas

AcceptedResponse

Field	Type	Required	Description
`status`	string	yes	Always `accepted`: the response never reveals whether the address has an account.

AnnotationCreateRequest

Field	Type	Required
`content`	string	yes
`kind`	string	yes
`occurred_at`	string (date-time)	yes
`ref`	object \| null

AnnotationDto

Annotation (defs-annotation.schema.json).

Field	Type	Required
`content`	string	yes
`created_at`	string (date-time)	yes
`created_by`	string (uuid) \| null
`id`	string (uuid)	yes
`kind`	string	yes
`occurred_at`	string (date-time)	yes
`project_id`	string (uuid)	yes
`ref`	object \| null
`source`	string	yes

AnnotationListResponse

Field	Type	Required	Description
`annotations`	AnnotationDto[]	yes

AnnotationUpdateRequest

Field	Type	Required	Description
`content`	string \| null
`kind`	string \| null
`occurred_at`	string (date-time) \| null

CapRequest

Field	Type	Required	Description
`spend_cap_minor`	integer (int64)	yes	The new spend cap in minor units of the account currency. Mandatory, never below the plan price plus overage already billed this period.

CapResponse

Field	Type	Required	Description
`previous_spend_cap_minor`	integer (int64)	yes
`spend_cap_minor`	integer (int64)	yes

CatalogCodegenExport

CatalogCodegenExport — what atrix codegen consumes.

Field	Type	Required
`catalog_version`	integer (int64)	yes
`events`	CodegenEventDto[]	yes
`project_id`	string (uuid)	yes

CatalogEventCreateRequest

Field	Type	Required
`description`	string \| null
`display_name`	string \| null
`name`	string	yes
`owner_id`	string (uuid) \| null
`pii_level`	string \| null
`platforms`	string[] \| null
`properties`	CatalogPropertyInput[] \| null
`question`	string \| null
`status`	string \| null
`tags`	string[] \| null

CatalogEventDto

CatalogEvent (defs-catalog.schema.json).

Field	Type	Required
`created_at`	string (date-time)	yes
`description`	string \| null
`display_name`	string \| null
`first_seen_at`	string (date-time) \| null
`id`	string (uuid)	yes
`kind`	string	yes
`last_seen_at`	string (date-time) \| null
`name`	string	yes
`owner_id`	string (uuid) \| null
`pii_level`	string	yes
`platforms`	string[]	yes
`project_id`	string (uuid)	yes
`properties`	CatalogPropertyDto[]	yes
`question`	string \| null
`status`	string	yes
`tags`	string[]	yes
`updated_at`	string (date-time)	yes
`version`	integer (int32)	yes
`volume_30d`	integer (int64) \| null

CatalogEventListResponse

Field	Type	Required	Description
`counts`	CatalogStatusCounts	yes
`events`	CatalogEventDto[]	yes

CatalogEventUpdateRequest

Field	Type	Required	Description
`description`	string \| null
`display_name`	string \| null
`owner_id`	string (uuid) \| null
`pii_level`	string \| null
`platforms`	string[] \| null
`properties`	CatalogPropertyInput[] \| null
`question`	string \| null
`status`	string \| null
`tags`	string[] \| null

CatalogPropertyDto

CatalogProperty.

Field	Type	Required
`description`	string \| null
`enum_values`	string[] \| null
`event_id`	string (uuid) \| null
`example`	string \| null
`id`	string (uuid)	yes
`name`	string	yes
`pii`	string	yes
`required`	boolean	yes
`scope`	string	yes
`type`	string	yes

CatalogPropertyInput

Field	Type	Required
`description`	string \| null
`enum_values`	string[] \| null
`example`	string \| null
`name`	string	yes
`pii`	string \| null
`required`	boolean \| null
`type`	string	yes

CatalogStatusCounts

Field	Type	Required
`deprecated`	integer (int64)	yes
`implemented`	integer (int64)	yes
`planned`	integer (int64)	yes
`unplanned`	integer (int64)	yes
`verified`	integer (int64)	yes

CatalogSyncRequest

Field	Type	Required	Description
`days`	integer (int32) \| null		(min 0)
`environment`	string \| null

CatalogSyncResponse

Field	Type	Required
`discovered`	integer (int64)	yes
`environment`	string	yes
`implemented`	string[]	yes
`synced_at`	string (date-time)	yes
`unplanned`	string[]	yes
`updated`	integer (int64)	yes

ChangePasswordRequest

Field	Type	Required	Description
`current_password`	string	yes
`new_password`	string	yes	Same policy as signup: at least 10 characters, not common, not breached.

CheckoutRequest

Field	Type	Required	Description
`plan`	string	yes	`starter`, `growth` or `scale`.

CodegenEventDto

Field	Type	Required
`description`	string \| null
`name`	string	yes
`properties`	CodegenPropertyDto[]	yes
`status`	string	yes

CodegenPropertyDto

Field	Type	Required
`description`	string \| null
`enum_values`	string[] \| null
`name`	string	yes
`required`	boolean	yes
`type`	string	yes

CohortCalculateRequest

Field	Type	Required	Description
`environment`	string \| null

CohortCalculationDto

CohortCalculation.

Field	Type	Required	Description
`calculated_at`	string (date-time)	yes
`cohort_version`	integer (int64) \| null
`environment`	string	yes
`error`	string \| null
`size`	integer (int64) \| null
`status`	string	yes	ok

CohortCreateRequest

Field	Type	Required
`definition`	object \| null
`description`	string \| null
`kind`	string	yes
`name`	string	yes

CohortDto

Cohort (defs-cohort.schema.json).

Field	Type	Required	Description
`calculation`	any \| null \| CohortCalculationDto
`created_at`	string (date-time)	yes
`created_by`	string (uuid) \| null
`definition`	object \| null
`description`	string \| null
`id`	string (uuid)	yes
`kind`	string	yes	dynamic
`name`	string	yes
`project_id`	string (uuid)	yes
`updated_at`	string (date-time)	yes
`version`	integer (int32)	yes

CohortListResponse

Field	Type	Required	Description
`cohorts`	CohortDto[]	yes

CohortUpdateRequest

Field	Type	Required	Description
`definition`	object \| null
`description`	string \| null
`name`	string \| null

ConnectionDto

Field	Type	Required	Description
`client_id`	string	yes
`client_name`	string	yes
`created_at`	string (date-time)	yes
`id`	string (uuid)	yes	The grant id.
`last_used_at`	string (date-time) \| null
`org_id`	string (uuid)	yes
`scopes`	string[]	yes

ConnectionList

Field	Type	Required	Description
`connections`	ConnectionDto[]	yes

CreatedTokenResponse

Field	Type	Required	Description
`secret`	string	yes	The secret. Shown exactly once; only its hash is stored.
`token`	TokenDto	yes

CreateIntegrationRequest

Field	Type	Required	Description
`config`	object \| null
`name`	string \| null
`provider`	string	yes	`stripe`
`secret`	string \| null		Stripe: the endpoint's signing secret (`whsec_…`). RevenueCat: the Authorization header value configured in its dashboard. App Store and Google Play take none.

CreateProjectRequest

Field	Type	Required	Description
`currency`	string \| null		ISO 4217, default `USD`.
`name`	string	yes
`region`	string	yes	Region code. Fixed for the life of the project. Only `live` regions are accepted.
`timezone`	string \| null		IANA zone, default `UTC`.

CreateProjectResponse

Field	Type	Required	Description
`project`	ProjectDto	yes
`public_keys`	KeyDto[]	yes	One write-only public key per environment.

CreateTokenRequest

Field	Type	Required	Description
`expires_in_days`	integer (int32) \| null		1–365. Omit for a token that never expires. (min 0)
`name`	string	yes
`org_id`	string (uuid)	yes
`project_ids`	string (uuid)[] \| null		Restrict to these projects. Omit for every project in the org.
`scopes`	string[]	yes	e.g. `["projects:read", "query:read"]`. Must be held by your role; no wildcard exists.

DashboardCreateRequest

Field	Type	Required
`date_range`	object \| null
`description`	string \| null
`filters`	object \| null
`is_home`	boolean \| null
`name`	string	yes
`tags`	string[] \| null

DashboardDto

Dashboard (defs-dashboard.schema.json).

Field	Type	Required
`created_at`	string (date-time)	yes
`created_by`	string (uuid) \| null
`date_range`	object \| null
`description`	string \| null
`filters`	object \| null
`id`	string (uuid)	yes
`is_home`	boolean	yes
`name`	string	yes
`project_id`	string (uuid)	yes
`tags`	string[]	yes
`tiles`	DashboardTileDto[]	yes
`updated_at`	string (date-time)	yes

DashboardListResponse

Field	Type	Required	Description
`dashboards`	DashboardSummaryDto[]	yes

DashboardSummaryDto

Field	Type	Required
`created_at`	string (date-time)	yes
`description`	string \| null
`id`	string (uuid)	yes
`is_home`	boolean	yes
`name`	string	yes
`tags`	string[]	yes
`tile_count`	integer (int64)	yes
`updated_at`	string (date-time)	yes

DashboardTileDto

Field	Type	Required	Description
`body`	string \| null
`created_at`	string (date-time)	yes
`id`	string (uuid)	yes
`insight`	any \| null \| InsightDto
`insight_id`	string (uuid) \| null
`kind`	string	yes	insight
`layout`	TileLayout	yes

DashboardUpdateRequest

Field	Type	Required	Description
`date_range`	object \| null
`description`	string \| null
`filters`	object \| null
`is_home`	boolean \| null
`name`	string \| null
`tags`	string[] \| null

DestinationConfig

Field	Type	Required	Description
`channel`	string \| null
`to`	string[]

DestinationCreateRequest

Field	Type	Required	Description
`config`	any \| null \| DestinationConfig
`enabled`	boolean \| null
`kind`	string	yes
`min_severity`	string \| null
`name`	string	yes
`secret`	string \| null		slack: the incoming-webhook URL; webhook: the endpoint URL.
`signing_secret`	string \| null		webhook: the HMAC signing secret.

DestinationDto

FindingsDestination (findings-destination.schema.json). The secret is never returned.

Field	Type	Required
`config`	DestinationConfig	yes
`created_at`	string (date-time)	yes
`created_by`	string (uuid) \| null
`enabled`	boolean	yes
`has_secret`	boolean	yes
`id`	string (uuid)	yes
`kind`	string	yes
`min_severity`	string	yes
`name`	string	yes
`project_id`	string (uuid)	yes
`secret_hint`	string \| null
`updated_at`	string (date-time)	yes

DestinationListResponse

Field	Type	Required	Description
`destinations`	DestinationDto[]	yes

DestinationUpdateRequest

Field	Type	Required	Description
`config`	any \| null \| DestinationConfig
`enabled`	boolean \| null
`min_severity`	string \| null
`name`	string \| null
`secret`	string \| null
`signing_secret`	string \| null

DryRun

What a write would do, without doing it (?dry_run=true on /v1 writes).

Field	Type	Required	Description
`action`	string	yes	The audit action the write would record, e.g. `project.rename`.
`after`	any
`before`	any
`dry_run`	boolean	yes	Always `true`.

EnvironmentDto

Field	Type	Required
`id`	string (uuid)	yes
`is_default`	boolean	yes
`name`	string	yes

EnvironmentList

Field	Type	Required	Description
`environments`	EnvironmentDto[]	yes

ErrorBody

Field	Type	Required	Description
`error`	ErrorDetail	yes

ErrorDetail

Field	Type	Required	Description
`code`	string	yes	Stable machine-readable code, e.g. `not_found`, `missing_scope`, `validation`.
`message`	string	yes

ExperimentCreateRequest

Field	Type	Required
`alpha`	number (double) \| null
`attribution_window_hours`	integer (int32) \| null
`control_variant`	string \| null
`cuped`	any \| null \| ExperimentCuped
`environment`	string \| null
`flag_id`	string (uuid)	yes
`guardrails`	ExperimentGuardrail[] \| null
`hypothesis`	string \| null
`key`	string	yes
`mde`	number (double) \| null
`method`	string \| null
`name`	string	yes
`power`	number (double) \| null
`primary_metric_id`	string (uuid) \| null
`secondary_metric_ids`	string (uuid)[] \| null
`winsor_pct`	number (double) \| null

ExperimentCuped

ExperimentCuped.

Field	Type	Required	Description
`enabled`	boolean	yes
`pre_period_days`	integer (int32)	yes	(min 0)

ExperimentDto

Experiment.

Field	Type	Required
`alpha`	number (double)	yes
`attribution_window_hours`	integer (int32)	yes
`control_variant`	string	yes
`created_at`	string (date-time)	yes
`created_by`	string (uuid) \| null
`cuped`	any \| null \| ExperimentCuped
`decision`	object \| null
`end_at`	string (date-time) \| null
`environment`	string	yes
`exposure_event`	string	yes
`flag_id`	string (uuid)	yes
`flag_key`	string	yes
`guardrails`	ExperimentGuardrail[]	yes
`hypothesis`	string \| null
`id`	string (uuid)	yes
`key`	string	yes
`mde`	number (double) \| null
`method`	string	yes
`name`	string	yes
`power`	number (double)	yes
`primary_metric`	any \| null \| ExperimentMetricRef
`project_id`	string (uuid)	yes
`secondary_metrics`	ExperimentMetricRef[]	yes
`shipped_variant`	string \| null
`start_at`	string (date-time) \| null
`status`	string	yes
`updated_at`	string (date-time)	yes
`variants`	object[]	yes
`winsor_pct`	number (double) \| null

ExperimentGuardrail

ExperimentGuardrail (request and response).

Field	Type	Required	Description
`key`	string \| null
`kind`	string \| null
`margin`	number (double)	yes
`margin_kind`	string		relative (default)
`metric_id`	string (uuid)	yes
`name`	string \| null

ExperimentListResponse

Field	Type	Required	Description
`experiments`	ExperimentDto[]	yes

ExperimentMetricRef

ExperimentMetricRef.

Field	Type	Required	Description
`higher_is_better`	boolean	yes
`key`	string	yes
`kind`	string	yes	proportion
`metric_id`	string (uuid)	yes
`name`	string	yes

ExperimentPlanRequest

ExperimentPlanRequest: atrix-stats planning input.

Field	Type	Required	Description
`alpha`	number (double) \| null
`control_units`	number (double) \| null
`daily_units`	number (double) \| null
`mde`	number (double)	yes
`mde_kind`	string \| null
`method`	string \| null
`metric`	object	yes
`power`	number (double) \| null
`variants`	integer (int32) \| null		(min 0)

ExperimentPlanResponse

Field	Type	Required	Description
`mde_at_control_units`	object \| null
`plan`	object	yes

ExperimentResultsDto

ExperimentResults.

Field	Type	Required
`analysis`	object	yes
`computed_at`	string (date-time)	yes
`data_through`	string (date-time)	yes
`experiment_id`	string (uuid)	yes
`metrics`	map of string → ExperimentMetricRef	yes
`stats`	object	yes
`stats_version`	string	yes

ExperimentTransitionRequest

Field	Type	Required	Description
`override_block`	boolean \| null
`reason`	string \| null
`variant`	string \| null

ExperimentUpdateRequest

Field	Type	Required	Description
`alpha`	number (double) \| null
`attribution_window_hours`	integer (int32) \| null
`control_variant`	string \| null
`cuped`	any \| null \| ExperimentCuped
`guardrails`	ExperimentGuardrail[] \| null
`hypothesis`	string \| null
`mde`	number (double) \| null
`method`	string \| null
`name`	string \| null
`power`	number (double) \| null
`primary_metric_id`	string (uuid) \| null
`secondary_metric_ids`	string (uuid)[] \| null
`winsor_pct`	number (double) \| null

FlagCreateRequest

Field	Type	Required	Description
`description`	string \| null
`key`	string	yes
`kind`	string \| null		boolean
`name`	string	yes
`payload`	object \| null
`rules`	object[] \| null
`stickiness`	string \| null
`tags`	string[] \| null
`variants`	object[] \| null

FlagDto

Flag.

Field	Type	Required
`archived_at`	string (date-time) \| null
`created_at`	string (date-time)	yes
`created_by`	string (uuid) \| null
`description`	string \| null
`environments`	map of string → FlagEnvironmentConfigDto	yes
`experiment_id`	string (uuid) \| null
`id`	string (uuid)	yes
`key`	string	yes
`kind`	string	yes
`name`	string	yes
`owner_id`	string (uuid) \| null
`project_id`	string (uuid)	yes
`tags`	string[]	yes
`updated_at`	string (date-time)	yes

FlagEnvironmentConfigDto

FlagEnvironmentConfig.

Field	Type	Required
`enabled`	boolean	yes
`environment`	string	yes
`payload`	object	yes
`rules`	object[]	yes
`salt`	string	yes
`stickiness`	string	yes
`updated_at`	string (date-time)	yes
`updated_by`	string (uuid) \| null
`variants`	object[]	yes
`version`	integer (int32)	yes

FlagEnvironmentUpdateRequest

Field	Type	Description
`enabled`	boolean \| null
`payload`	object \| null	`null` clears the payload.
`rules`	object[] \| null
`salt`	string \| null
`stickiness`	string \| null
`variants`	object[] \| null

FlagListResponse

Field	Type	Required	Description
`flags`	FlagDto[]	yes

FlagPublicationDto

FlagPublication.

Field	Type	Required
`checksum`	string	yes
`created_at`	string (date-time)	yes
`environment`	string	yes
`error`	string \| null
`id`	string (uuid)	yes
`published_at`	string (date-time) \| null
`status`	string	yes
`version`	integer (int64)	yes

FlagPublicationListResponse

Field	Type	Required	Description
`publications`	FlagPublicationDto[]	yes

FlagSecretKeyCreated

Field	Type	Required	Description
`key`	FlagSecretKeyDto	yes
`secret`	string	yes	Shown once.

FlagSecretKeyCreateRequest

Field	Type	Required	Description
`environment`	string	yes
`name`	string	yes

FlagSecretKeyDto

FlagSecretKey.

Field	Type	Required
`created_at`	string (date-time)	yes
`created_by`	string (uuid) \| null
`environment`	string	yes
`id`	string (uuid)	yes
`name`	string	yes
`prefix`	string	yes
`project_id`	string (uuid)	yes
`revoked_at`	string (date-time) \| null

FlagSecretKeyListResponse

Field	Type	Required	Description
`keys`	FlagSecretKeyDto[]	yes

FlagUpdateRequest

Field	Type	Required	Description
`description`	string \| null
`name`	string \| null
`owner_id`	string (uuid) \| null
`tags`	string[] \| null

HealthResponse

Field	Type	Required	Description
`checks`	map of string → string	yes	`global`, `region:eu`, … → ok
`status`	string	yes	ok

InsightCreateRequest

Field	Type	Required	Description
`created_via`	string \| null		ui
`description`	string \| null
`favorited`	boolean \| null
`name`	string	yes
`query`	object	yes
`tags`	string[] \| null
`viz`	object \| null

InsightDto

Insight (defs-insight.schema.json).

Field	Type	Required	Description
`created_at`	string (date-time)	yes
`created_by`	string (uuid) \| null
`created_via`	string	yes
`description`	string \| null
`favorited`	boolean	yes	Whether the caller starred it (favourites are per user).
`id`	string (uuid)	yes
`name`	string	yes
`project_id`	string (uuid)	yes
`query`	object	yes	Query IR v1 (query-ir.schema.json).
`tags`	string[]	yes
`updated_at`	string (date-time)	yes
`viz`	object	yes	InsightViz.

InsightFavoriteRequest

PUT …/insights/{insight_id}/favorite.

Field	Type	Required	Description
`favorite`	boolean	yes

InsightListResponse

Field	Type	Required	Description
`insights`	InsightDto[]	yes
`next_offset`	integer (int64) \| null

InsightUpdateRequest

Field	Type	Required	Description
`description`	string \| null
`favorited`	boolean \| null
`name`	string \| null
`query`	object \| null
`tags`	string[] \| null
`viz`	object \| null

IntegrationDto

Field	Type	Required	Description
`config`	object	yes	Non-secret settings (bundle id, package name, Play price catalog, …).
`created_at`	string (date-time)	yes
`has_secret`	boolean	yes	Whether a secret is stored. The secret itself is never returned.
`id`	string (uuid)	yes
`name`	string \| null
`project_id`	string (uuid)	yes
`provider`	string	yes	`stripe`
`region_synced`	boolean	yes	The region has the current configuration (capture verifies with it).
`secret_last4`	string \| null
`status`	string	yes	`active`
`updated_at`	string (date-time)	yes
`webhook_url`	string	yes	Paste this into the provider's webhook settings.

IntegrationList

Field	Type	Required	Description
`integrations`	IntegrationDto[]	yes

InvitationDto

Field	Type	Required
`created_at`	string (date-time)	yes
`email`	string	yes
`expires_at`	string (date-time)	yes
`id`	string (uuid)	yes
`org_id`	string (uuid)	yes
`role`	string	yes
`status`	string	yes

InviteRequest

Field	Type	Required	Description
`email`	string	yes
`role`	string	yes	owner

KeyDto

Field	Type	Required	Description
`allowed_bundle_ids`	string[]	yes
`allowed_origins`	string[]	yes
`created_at`	string (date-time)	yes
`environment`	string	yes
`id`	string (uuid)	yes
`key`	string	yes	`atx_pk_<region>_<env>_<22>` — safe to embed in apps; it can only send events.
`project_id`	string (uuid)	yes
`registry_synced`	boolean	yes	Whether the region's capture service has this key's latest state.
`revoked_at`	string (date-time) \| null

KeyList

Field	Type	Required	Description
`keys`	KeyDto[]	yes

LayoutRequest

Field	Type	Required	Description
`tiles`	TilePosition[]	yes

LoginRequest

Field	Type	Required	Description
`email`	string	yes
`password`	string	yes

MemberDto

Field	Type	Required
`created_at`	string (date-time)	yes
`email`	string	yes
`id`	string (uuid)	yes
`name`	string	yes
`role`	string	yes
`user_id`	string (uuid)	yes

MembersResponse

Field	Type	Required	Description
`invitations`	InvitationDto[]	yes	Pending invitations; only listed for callers who may manage members.
`members`	MemberDto[]	yes

MeResponse

Field	Type	Required	Description
`orgs`	OrgDto[]	yes
`user`	UserDto	yes

MetricCreateRequest

Field	Type	Required
`description`	string \| null
`direction`	string \| null
`key`	string	yes
`monitor`	boolean \| null
`name`	string	yes
`owner_id`	string (uuid) \| null
`query`	object	yes
`unit`	string \| null

MetricDto

Metric (defs-metric.schema.json).

Field	Type	Required
`archived_at`	string (date-time) \| null
`certified`	boolean	yes
`certified_at`	string (date-time) \| null
`certified_by`	string (uuid) \| null
`created_at`	string (date-time)	yes
`description`	string \| null
`direction`	string	yes
`id`	string (uuid)	yes
`key`	string	yes
`kind`	string	yes
`monitor`	boolean	yes
`name`	string	yes
`owner_id`	string (uuid) \| null
`project_id`	string (uuid)	yes
`query`	object	yes
`unit`	string \| null
`version`	integer (int32)	yes

MetricListResponse

Field	Type	Required	Description
`metrics`	MetricDto[]	yes

MetricUpdateRequest

Field	Type	Required	Description
`description`	string \| null
`direction`	string \| null
`monitor`	boolean \| null
`name`	string \| null
`owner_id`	string (uuid) \| null
`query`	object \| null
`unit`	string \| null

OrgDto

Field	Type	Required	Description
`created_at`	string (date-time)	yes
`id`	string (uuid)	yes
`name`	string	yes
`role`	string	yes	Your role: owner
`slug`	string	yes

OrgList

Field	Type	Required	Description
`orgs`	OrgDto[]	yes

OrgNameRequest

Field	Type	Required	Description
`name`	string	yes

PasswordResetConfirm

Field	Type	Required	Description
`new_password`	string	yes
`token`	string	yes	The single-use token from the emailed link.

PasswordResetRequest

Field	Type	Required	Description
`email`	string	yes

PortalResponse

Field	Type	Required	Description
`url`	string	yes

ProjectDto

Field	Type	Required	Description
`created_at`	string (date-time)	yes
`currency`	string	yes
`data_id`	integer (int32)	yes	Numeric id used by the data plane (ClickHouse `project_id`).
`environments`	EnvironmentDto[]	yes
`id`	string (uuid)	yes
`name`	string	yes
`org_id`	string (uuid)	yes
`region`	string	yes
`retention_days`	integer (int32)	yes
`role`	string	yes	Your effective role in this project.
`slug`	string	yes
`timezone`	string	yes

ProjectList

Field	Type	Required	Description
`projects`	ProjectDto[]	yes

RegionDto

Field	Type	Required	Description
`api_host`	string \| null
`code`	string	yes	`eu`, `me`, `us`, `pk`.
`ingest_host`	string \| null
`name`	string	yes
`status`	string	yes	live

RegionList

Field	Type	Required	Description
`regions`	RegionDto[]	yes

RegionRequestDto

Field	Type	Required	Description
`body`	object	yes	Send with `Authorization: Bearer <token>`.
`method`	string	yes
`url`	string	yes	The region API endpoint. Results come straight from the region, never through the control plane.

RegionTokenRequest

Field	Type	Required	Description
`environment`	string \| null		production
`scopes`	string[] \| null		Narrow further. Omit for every regional scope you hold.

RegionTokenResponse

Field	Type	Required	Description
`environment`	string	yes
`expires_at`	string (date-time)	yes
`region`	string	yes
`region_api_url`	string	yes
`scopes`	string[]	yes
`token`	string	yes	EdDSA JWT (`RegionTokenClaims`). Send as `Authorization: Bearer` to `region_api_url`.

RegisterRequest

Field	Type	Required
`client_name`	string \| null
`client_uri`	string \| null
`grant_types`	string[] \| null
`logo_uri`	string \| null
`policy_uri`	string \| null
`redirect_uris`	string[]	yes
`response_types`	string[] \| null
`scope`	string \| null
`software_id`	string \| null
`software_version`	string \| null
`token_endpoint_auth_method`	string \| null
`tos_uri`	string \| null

RegisterResponse

Field	Type	Required
`client_id`	string	yes
`client_id_issued_at`	integer (int64)	yes
`client_name`	string	yes
`grant_types`	string[]	yes
`redirect_uris`	string[]	yes
`response_types`	string[]	yes
`scope`	string	yes
`token_endpoint_auth_method`	string	yes

RenameRequest

Field	Type	Required	Description
`name`	string	yes

RevokeOthersResponse

Field	Type	Required	Description
`revoked`	integer (int64)	yes	How many other sessions were signed out. (min 0)

RoleRequest

Field	Type	Required	Description
`role`	string	yes

RotateKeyRequest

Field	Type	Required	Description
`keep_old`	boolean		Keep the old key working (revoke it later). Default: revoke it now.

RotateKeyResponse

Field	Type	Required	Description
`created`	KeyDto	yes	The replacement key.
`revoked`	KeyDto	yes	The key being replaced. `revoked_at` is still `null` when `keep_old` was set.

RuleCreateRequest

Field	Type	Required
`cadence`	string \| null
`daily_cap`	integer (int32) \| null
`destination_ids`	string (uuid)[] \| null
`enabled`	boolean \| null
`min_severity`	string \| null
`name`	string	yes
`target`	RuleTarget	yes
`thresholds`	any \| null \| Thresholds

RuleDto

FindingsRule (findings-rule.schema.json).

Field	Type	Required
`cadence`	string	yes
`created_at`	string (date-time)	yes
`created_by`	string (uuid) \| null
`daily_cap`	integer (int32) \| null
`destination_ids`	string (uuid)[]	yes
`enabled`	boolean	yes
`id`	string (uuid)	yes
`min_severity`	string	yes
`name`	string	yes
`project_id`	string (uuid)	yes
`target`	RuleTarget	yes
`thresholds`	Thresholds	yes
`updated_at`	string (date-time)	yes

RuleListResponse

Field	Type	Required	Description
`rules`	RuleDto[]	yes

RuleTarget

Field	Type	Required
`event`	string \| null
`from_event`	string \| null
`key`	string \| null
`kind`	string	yes
`to_event`	string \| null

RuleUpdateRequest

Field	Type	Description
`cadence`	string \| null
`daily_cap`	integer (int32) \| null	`null` clears the cap (deployment default).
`destination_ids`	string (uuid)[] \| null
`enabled`	boolean \| null
`min_severity`	string \| null
`name`	string \| null
`target`	any \| null \| RuleTarget
`thresholds`	any \| null \| Thresholds

SessionDto

One signed-in session of the current user. Never carries an IP address: location is a coarse place (city, country) when one is known, else null.

Field	Type	Required	Description
`created_at`	string (date-time)	yes
`current`	boolean	yes	The session making this request.
`expires_at`	string (date-time)	yes
`id`	string (uuid)	yes
`last_seen_at`	string (date-time)	yes
`location`	string \| null
`user_agent`	string \| null

SessionList

Field	Type	Required	Description
`sessions`	SessionDto[]	yes

SignupRequest

Field	Type	Required	Description
`email`	string	yes
`name`	string	yes
`password`	string	yes	At least 10 characters; common and breached passwords are refused.

Thresholds

Field	Type	Description
`min_abs_delta`	number (double) \| null
`min_rel_delta`	number (double) \| null
`min_sample`	integer (int64) \| null	(min 0)
`z`	number (double) \| null

TileCreateRequest

Field	Type	Required	Description
`body`	string \| null
`insight_id`	string (uuid) \| null
`kind`	string	yes	insight
`layout`	any \| null \| TileLayout

TileLayout

Field	Type	Required
`h`	integer (int32)	yes
`w`	integer (int32)	yes
`x`	integer (int32)	yes
`y`	integer (int32)	yes

TilePosition

Field	Type	Required	Description
`id`	string (uuid)	yes
`layout`	TileLayout	yes

TileUpdateRequest

Field	Type	Required	Description
`body`	string \| null
`layout`	any \| null \| TileLayout

TokenDto

Field	Type	Required	Description
`created_at`	string (date-time)	yes
`expires_at`	string (date-time) \| null
`id`	string (uuid)	yes
`kind`	string	yes
`last_used_at`	string (date-time) \| null
`name`	string	yes
`org_id`	string (uuid)	yes
`prefix`	string	yes	Public identifier (`atx_pat_<lookup>…`), safe to display.
`project_ids`	string (uuid)[] \| null
`revoked_at`	string (date-time) \| null
`scopes`	string[]	yes

TokenForm

Documentation shape of the token request (form-encoded).

Field	Type	Required	Description
`client_id`	string \| null
`code`	string \| null
`code_verifier`	string \| null
`grant_type`	string	yes	`authorization_code` or `refresh_token`.
`redirect_uri`	string \| null
`refresh_token`	string \| null
`resource`	string \| null
`scope`	string \| null

TokenList

Field	Type	Required	Description
`tokens`	TokenDto[]	yes

TokenRequest

Field	Type	Required	Description
`token`	string	yes	The single-use token from the emailed link.

TokenResponse

Field	Type	Required	Description
`access_token`	string	yes
`expires_in`	integer (int64)	yes
`refresh_token`	string	yes
`scope`	string	yes	Always echoed: frequently narrower than what was asked for.
`token_type`	string	yes

UpdateIntegrationRequest

Field	Type	Description
`config`	object \| null
`name`	string \| null
`secret`	string \| null	Replace the stored secret (rotation).
`status`	string \| null	`active`

UserDto

Field	Type	Required
`created_at`	string (date-time)	yes
`email`	string	yes
`email_verified`	boolean	yes
`id`	string (uuid)	yes
`name`	string	yes

V1MeResponse

Field	Type	Required	Description
`effective_scopes`	string[]	yes	Effective org-level scopes: the token's scopes ∩ the owner's role.
`token`	TokenDto	yes
`user`	any \| null \| UserDto

V1QueryRequest

Field	Type	Required	Description
`environment`	string \| null		production
`include_sql`	boolean		Ask the region to include the compiled SQL in its answer.
`query`	object	yes	A Query IR v1 document (`packages/contracts/schemas/query-ir.schema.json`).
`refresh`	boolean		Bypass the region's result cache.

V1QueryResponse

Field	Type	Required	Description
`environment`	string	yes
`expires_at`	string (date-time)	yes
`kind`	string	yes	The validated insight kind (`trends`, `funnel`, `retention`, …).
`region`	string	yes
`request`	RegionRequestDto	yes
`token`	string	yes	Region token narrowed to `query:read`.

AcceptedResponseCopy Anchor Link

AnnotationCreateRequestCopy Anchor Link

AnnotationDtoCopy Anchor Link

AnnotationListResponseCopy Anchor Link

AnnotationUpdateRequestCopy Anchor Link

CapRequestCopy Anchor Link

CapResponseCopy Anchor Link

CatalogCodegenExportCopy Anchor Link

CatalogEventCreateRequestCopy Anchor Link

CatalogEventDtoCopy Anchor Link

CatalogEventListResponseCopy Anchor Link

CatalogEventUpdateRequestCopy Anchor Link

CatalogPropertyDtoCopy Anchor Link

CatalogPropertyInputCopy Anchor Link

CatalogStatusCountsCopy Anchor Link

CatalogSyncRequestCopy Anchor Link

CatalogSyncResponseCopy Anchor Link

ChangePasswordRequestCopy Anchor Link

CheckoutRequestCopy Anchor Link

CodegenEventDtoCopy Anchor Link

CodegenPropertyDtoCopy Anchor Link

CohortCalculateRequestCopy Anchor Link

CohortCalculationDtoCopy Anchor Link

CohortCreateRequestCopy Anchor Link

CohortDtoCopy Anchor Link

CohortListResponseCopy Anchor Link

CohortUpdateRequestCopy Anchor Link

ConnectionDtoCopy Anchor Link

ConnectionListCopy Anchor Link

CreatedTokenResponseCopy Anchor Link

CreateIntegrationRequestCopy Anchor Link

CreateProjectRequestCopy Anchor Link

CreateProjectResponseCopy Anchor Link

CreateTokenRequestCopy Anchor Link

DashboardCreateRequestCopy Anchor Link

DashboardDtoCopy Anchor Link

DashboardListResponseCopy Anchor Link

DashboardSummaryDtoCopy Anchor Link

DashboardTileDtoCopy Anchor Link

DashboardUpdateRequestCopy Anchor Link

DestinationConfigCopy Anchor Link

DestinationCreateRequestCopy Anchor Link

DestinationDtoCopy Anchor Link

DestinationListResponseCopy Anchor Link

DestinationUpdateRequestCopy Anchor Link

DryRunCopy Anchor Link

EnvironmentDtoCopy Anchor Link

EnvironmentListCopy Anchor Link

ErrorBodyCopy Anchor Link

ErrorDetailCopy Anchor Link

ExperimentCreateRequestCopy Anchor Link

ExperimentCupedCopy Anchor Link

ExperimentDtoCopy Anchor Link

ExperimentGuardrailCopy Anchor Link

ExperimentListResponseCopy Anchor Link

ExperimentMetricRefCopy Anchor Link

ExperimentPlanRequestCopy Anchor Link

ExperimentPlanResponseCopy Anchor Link

ExperimentResultsDtoCopy Anchor Link

ExperimentTransitionRequestCopy Anchor Link

ExperimentUpdateRequestCopy Anchor Link

FlagCreateRequestCopy Anchor Link

FlagDtoCopy Anchor Link

FlagEnvironmentConfigDtoCopy Anchor Link

FlagEnvironmentUpdateRequestCopy Anchor Link

FlagListResponseCopy Anchor Link

FlagPublicationDtoCopy Anchor Link

FlagPublicationListResponseCopy Anchor Link

FlagSecretKeyCreatedCopy Anchor Link

FlagSecretKeyCreateRequestCopy Anchor Link

FlagSecretKeyDtoCopy Anchor Link

FlagSecretKeyListResponseCopy Anchor Link

FlagUpdateRequestCopy Anchor Link

HealthResponseCopy Anchor Link

InsightCreateRequestCopy Anchor Link

InsightDtoCopy Anchor Link

InsightFavoriteRequestCopy Anchor Link

InsightListResponseCopy Anchor Link

InsightUpdateRequestCopy Anchor Link