Skip to main content
GET
Get the management briefing

Authorizations

Authorization
string
header
required

Opaque mvy_test_ API key sent as a Bearer token. It derives exactly one workspace server-side; the path never carries a workspace selector.

Headers

Accept-Language
string

The language of every figure label: en, es or pt (default en). Metric keys, dimensions, units, values and evidence ids never change with it.

Query Parameters

period
enum<string>

The briefing cadence; defaults to daily.

Available options:
daily,
weekly

Response

The management briefing.

metric
string
required
definition
string
required

The human-readable definition of the briefing.

period
enum<string>
required
Available options:
daily,
weekly
timezone
string
required
asOf
string<date-time>
required
freshness
enum<string>
required
Available options:
live
evidenceId
string
required
truncated
boolean
required

True when any composed metric hit its scan cap: a figure is a lower bound.

figures
object[]
required