Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Path Parameters

reportId
string<uuid>
required

The live report ID

Body

application/json
periodStart
string<date-time>

ISO 8601 start of a custom window. Omit both for the latest closed period.

periodEnd
string<date-time>

ISO 8601 end (exclusive) of a custom window. Requires periodStart.

Response

The document being written

data
object
required

One written report over one period. document is null until status is READY; every number in it comes from the analytics engine (the same reads GET /v1/dashboard/{dashboardId}/data makes over the same window and filters).