Skip to main content
GET
Get order lifecycle metrics

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

account_id
string<uuid>

Trading account ID. Omitted, the window covers every account in the organization

environment
enum<string>
required

Required. Which environment the read covers. Resolved to the organization's accounts in that environment, including disabled and deleted ones, since the ledger stores no environment of its own. Rejected with 400 when it disagrees with the account named alongside it.

Available options:
paper,
live
days
integer<int64>
required

Trailing day count. Clamped to 1..=90 and then to the window the caller's plan grants; a single day is reported as 24 hourly buckets

symbol
string

Filter by symbol. Symbols are normalized to uppercase; a blank value is treated as no filter

Response

Lifecycle metrics retrieved

data
object[]
required

One entry per bucket, oldest first, including buckets in which nothing happened, so the series can be plotted without the caller filling gaps.

granularity
enum<string>
required

Width of one bucket in a stats series.

Available options:
hour,
day