Sign in
Private Analytics

List consumption analytics facets

Lists current entities and historical indexed values present in the selected period for each consumption dimension. The workspace route requires a manager; the /me route is restricted server-side to the authenticated member; the agent route is restricted server-side to workspace managers and editors of the selected agent. A facet is disabled when it has no indexed document in that period after applying every active filter except the facet's own dimension.

post/api/w/{wId}/analytics/consumption/facets

Path parameters

wIdstring required

Request body

period'cycle' | 'days'
daysinteger
scope'all' | 'automations'

Restricts which documents the facets are computed over. automations counts only trigger-originated runs.

dimensionsstring[]

Dimensions to compute facets for. Defaults to every dimension. Omitted dimensions come back as empty arrays. The personal route omits user and group dimensions, and the agent route omits the agent dimension.

Response

Consumption facets and their contextual availability

Changes