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

Changed in 4 of the 80 revisions of this API.117

  • 2e785b62895f2See the full diff
    • ○

      added the new optional request property dimensions

      new-optional-request-property

    • ○

      added the new optional request property scope

      new-optional-request-property

  • 24a308e0da1c2See the full diff
    • ○

      added the new optional request property filter/api_keys

      new-optional-request-property

    • ○

      added the required property facets/api_key to the response with the 200 status

      response-required-property-added

  • 41617009c89a112See the full diff
    • ▲

      removed the required property facets/team from the response with the 200 status

      response-required-property-removed

    • ●

      removed the request property filter/teams

      request-property-removed

    • ○

      added the new optional request property filter/groups

      new-optional-request-property

    • ○

      added the required property facets/group to the response with the 200 status

      response-required-property-added

  • 90cdd6d971e71See the full diff
    • ○

      endpoint added

      endpoint-added