Skip to main content
POST
Request a briefing export

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 the CSV figure labels: en, es or pt (default en), fixed when the export is requested. Metric keys, dimensions, units, values and evidence ids never change with it.

Body

application/json
period
enum<string>

The briefing cadence to export; defaults to daily.

Available options:
daily,
weekly

Response

The export job was accepted.

exportId
string
required

The opaque poll handle for the export job.

status
enum<string>
required
Available options:
pending,
building,
ready,
failed
reportType
enum<string>
required
Available options:
briefing
period
enum<string>
required
Available options:
daily,
weekly
byteSize
integer

Size of the built artifact in bytes; present once ready.

checksum
string

SHA-256 hex of the redacted artifact — the FR-AUD-02 checksum; present once ready.

error
string

A machine-readable, non-sensitive reason code; present only when the job failed.

downloadUrl
string

A short-lived signed download URL; present only when ready, re-minted on each poll.

downloadExpiresAt
string<date-time>

When the current download URL stops working.