computation

Query measures analytics

Changed on

Return aggregated values for specified metrics within a time range.

post/environments/{envId}/analytics/measures

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/measures
  • Auth
    none declared

Path parameters

envIdstring required

The unique ID of your environment

Request body

Example request

{
  "timeRange": {
    "from": "2025-01-01T00:00:00Z",
    "to": "2025-01-31T23:59:59Z"
  },
  "filters": [
    {
      "name": "API",
      "operator": "EQ",
      "value": "7b6ebef3-6236-4ac5-815e-d3dcef83df5d"
    }
  ],
  "metrics": [
    {
      "name": "HTTP_GATEWAY_RESPONSE_TIME",
      "measures": [
        "P90",
        "P95",
        "P99"
      ]
    }
  ]
}

Response

A measures response provides aggregated values for the metrics defined in the request.

Example response

{
  "metrics": [
    {
      "name": "HTTP_REQUESTS",
      "unit": "NUMBER",
      "measures": [
        {
          "name": "COUNT",
          "value": 2984
        }
      ]
    }
  ]
}

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_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_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 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 ////////