computation

Query facets analytics

Changed on Aug 18, 2026

Group data by facet values with optional ranging, sorting and limits.

Facet requests are limited to 3 dimensions in the by clause.

Sorting and ranging always apply to the last given facet.

post/environments/{envId}/analytics/facets

Request

Base URL
/management/v2 (relative, and the document was published on a file host, not at the API’s origin)
URL
/management/v2/environments/{envId}/analytics/facets
Auth
none declared

Path parameters

envIdstring required

The unique ID of your environment

Request body

byFacetName[] required

List of facet names to group by (applies to all metrics)

limitinteger

Maximum number of buckets to return (applies to all metrics)

Example request

{
  "timeRange": {
    "from": "2025-01-01T00:00:00Z",
    "to": "2025-01-31T23:59:59Z"
  },
  "by": [
    "API",
    "APPLICATION"
  ],
  "limit": 2,
  "metrics": [
    {
      "name": "HTTP_REQUESTS",
      "measures": [
        "COUNT"
      ],
      "sort": [
        {
          "measure": "COUNT",
          "order": "DESC"
        }
      ]
    }
  ]
}

Response

Facets analytics response

Example response

{
  "metrics": [
    {
      "name": "HTTP_REQUESTS",
      "unit": "NUMBER",
      "buckets": [
        {
          "key": "49ddd7db-35d6-497e-b497-2dc16af0cdcc",
          "name": "api-1",
          "type": "GROUP",
          "buckets": [
            {
              "key": "e65289b0-35b2-40e7-8d41-711fba7fdc96",
              "name": "app-1",
              "type": "LEAF",
              "measures": [
                {
                  "name": "COUNT",
                  "value": 45
                }
              ]
            },
            {
              "key": "4c65d87a-008a-4a4c-b11a-a38b7a662fcc",
              "name": "app-2",
              "type": "LEAF",
              "measures": [
                {
                  "name": "COUNT",
                  "value": 34
                }
              ]
            },
            {
              "key": "71091fd9-a6a9-4c7f-afdb-d837ea28058c",
              "name": "app-3",
              "type": "LEAF",
              "measures": [
                {
                  "name": "COUNT",
                  "value": 989
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Changes

Aug 18, 2026ff8d60356a08 Revision changes
- warning
  added the new NATIVE_ACTIVE_CONNECTIONS_DOWNSTREAM enum value to the // response property for the response status
- warning
  added the new NATIVE_ACTIVE_CONNECTIONS_UPSTREAM enum value to the // response property for the response status
- warning
  added the new NATIVE_AUTHENTICATIONS_FAILURE_DOWNSTREAM enum value to the // response property for the response status
- warning
  added the new NATIVE_AUTHENTICATIONS_FAILURE_UPSTREAM enum value to the // response property for the response status
- warning
  added the new NATIVE_AUTHENTICATIONS_SUCCESS_DOWNSTREAM enum value to the // response property for the response status
- warning
  added the new NATIVE_AUTHENTICATIONS_SUCCESS_UPSTREAM enum value to the // response property for the response status
- warning
  added the new NATIVE_BYTES_CONSUMED_DOWNSTREAM enum value to the // response property for the response status
- warning
  added the new NATIVE_BYTES_CONSUMED_UPSTREAM enum value to the // response property for the response status
- warning
  added the new NATIVE_BYTES_PRODUCED_DOWNSTREAM enum value to the // response property for the response status
- warning
  added the new NATIVE_BYTES_PRODUCED_UPSTREAM enum value to the // response property for the response status
- warning
  added the new NATIVE_MESSAGES_CONSUMED_DOWNSTREAM enum value to the // response property for the response status
- warning
  added the new NATIVE_MESSAGES_CONSUMED_UPSTREAM enum value to the // response property for the response status
- warning
  added the new NATIVE_MESSAGES_PRODUCED_DOWNSTREAM enum value to the // response property for the response status
- warning
  added the new NATIVE_MESSAGES_PRODUCED_UPSTREAM enum value to the // response property for the response status
- warning
  added the new NATIVE_OPERATIONS_ANSWERED enum value to the // response property for the response status
- warning
  added the new NATIVE_OPERATIONS_COMPLETED enum value to the // response property for the response status
- warning
  added the new NATIVE_OPERATIONS_FORWARDED enum value to the // response property for the response status
- warning
  added the new NATIVE_OPERATIONS_RECEIVED enum value to the // response property for the response status
- warning
  added the new NATIVE_OPERATION_BROKER_DURATION enum value to the // response property for the response status
- warning
  added the new NATIVE_OPERATION_GATEWAY_REQUEST_DURATION enum value to the // response property for the response status
- warning
  added the new NATIVE_OPERATION_GATEWAY_RESPONSE_DURATION enum value to the // response property for the response status
- info
  added the new NATIVE_ACTIVE_CONNECTIONS_DOWNSTREAM enum value to the request property //
- info
  added the new NATIVE_ACTIVE_CONNECTIONS_UPSTREAM enum value to the request property //
- info
  added the new NATIVE_AUTHENTICATIONS_FAILURE_DOWNSTREAM enum value to the request property //
- info
  added the new NATIVE_AUTHENTICATIONS_FAILURE_UPSTREAM enum value to the request property //
- info
  added the new NATIVE_AUTHENTICATIONS_SUCCESS_DOWNSTREAM enum value to the request property //
- info
  added the new NATIVE_AUTHENTICATIONS_SUCCESS_UPSTREAM enum value to the request property //
- info
  added the new NATIVE_BYTES_CONSUMED_DOWNSTREAM enum value to the request property //
- info
  added the new NATIVE_BYTES_CONSUMED_UPSTREAM enum value to the request property //
- info
  added the new NATIVE_BYTES_PRODUCED_DOWNSTREAM enum value to the request property //
- info
  added the new NATIVE_BYTES_PRODUCED_UPSTREAM enum value to the request property //
- info
  added the new NATIVE_CLIENT_ID enum value to the request property /
- info
  added the new NATIVE_CLIENT_ID enum value to the request property //////
- info
  added the new NATIVE_CLIENT_ID enum value to the request property //////
- info
  added the new NATIVE_CLIENT_ID enum value to the request property //////
- info
  added the new NATIVE_CLIENT_ID enum value to the request property ////////
- info
  added the new NATIVE_CLIENT_ID enum value to the request property ////////
- info
  added the new NATIVE_CLIENT_ID enum value to the request property ////////
- info
  added the new NATIVE_FAILURE_SIDE enum value to the request property /
- info
  added the new NATIVE_FAILURE_SIDE enum value to the request property //////
- info
  added the new NATIVE_FAILURE_SIDE enum value to the request property //////
- info
  added the new NATIVE_FAILURE_SIDE enum value to the request property //////
- info
  added the new NATIVE_FAILURE_SIDE enum value to the request property ////////
- info
  added the new NATIVE_FAILURE_SIDE enum value to the request property ////////
- info
  added the new NATIVE_FAILURE_SIDE enum value to the request property ////////
- info
  added the new NATIVE_MESSAGES_CONSUMED_DOWNSTREAM enum value to the request property //
- info
  added the new NATIVE_MESSAGES_CONSUMED_UPSTREAM enum value to the request property //
- info
  added the new NATIVE_MESSAGES_PRODUCED_DOWNSTREAM enum value to the request property //
- info
  added the new NATIVE_MESSAGES_PRODUCED_UPSTREAM enum value to the request property //
- info
  added the new NATIVE_OPERATION enum value to the request property /
- info
  added the new NATIVE_OPERATION enum value to the request property //////
- info
  added the new NATIVE_OPERATION enum value to the request property //////
- info
  added the new NATIVE_OPERATION enum value to the request property //////
- info
  added the new NATIVE_OPERATION enum value to the request property ////////
- info
  added the new NATIVE_OPERATION enum value to the request property ////////
- info
  added the new NATIVE_OPERATION enum value to the request property ////////
- info
  added the new NATIVE_OPERATIONS_ANSWERED enum value to the request property //
- info
  added the new NATIVE_OPERATIONS_COMPLETED enum value to the request property //
- info
  added the new NATIVE_OPERATIONS_FORWARDED enum value to the request property //
- info
  added the new NATIVE_OPERATIONS_RECEIVED enum value to the request property //
- info
  added the new NATIVE_OPERATION_BROKER_DURATION enum value to the request property //
- info
  added the new NATIVE_OPERATION_GATEWAY_REQUEST_DURATION enum value to the request property //
- info
  added the new NATIVE_OPERATION_GATEWAY_RESPONSE_DURATION enum value to the request property //
- info
  added the new NATIVE_TOPIC enum value to the request property /
- info
  added the new NATIVE_TOPIC enum value to the request property //////
- info
  added the new NATIVE_TOPIC enum value to the request property //////
- info
  added the new NATIVE_TOPIC enum value to the request property //////
- info
  added the new NATIVE_TOPIC enum value to the request property ////////
- info
  added the new NATIVE_TOPIC enum value to the request property ////////
- info
  added the new NATIVE_TOPIC enum value to the request property ////////
Jun 23, 202646635b009058 Revision changes
- info
  added CONTAINS discriminator mapping keys to the / request property
- info
  added CONTAINS discriminator mapping keys to the /// request property
- info
  added the new CONTAINS enum value to the request property //////
- info
  added the new CONTAINS enum value to the request property //////
- info
  added the new CONTAINS enum value to the request property //////
- info
  added the new CONTAINS enum value to the request property ////////
- info
  added the new CONTAINS enum value to the request property ////////
- info
  added the new CONTAINS enum value to the request property ////////

Operation history (27 revisions)