Skip to main content
POST
Get reporting by workspace

Body

application/json

One metric by workspace over the range.

metric
null | string
required

The metric to rank the workspaces by: received, closed, investigated, actions, breached or atRisk.

from
string<date>
required

The first day of the range, inclusive (UTC days). A range spans at most 366 days.

to
string<date>
required

The last day of the range, inclusive (UTC days).

top

How many workspaces to name before the remainder, from 1 to 10; 6 when omitted.

workspaceIds
null | string<uuid>[]

The workspaces to read, at most 500; null or empty reads every workspace the caller may see. A service account sees the workspaces it holds a role on.

Response

OK

Standard v2 API response envelope for single-item responses.

data
object

v2 one reporting metric by workspace: the highest workspaces and a remainder.

meta
object