GRgravitee-io
definition

Query available facets for a specific metric

Changed on

Returns a list of available facets that can be used to group data for a specific metric within an API type, including their data types.

get/environments/{envId}/analytics/definition/metrics/{metricName}/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/definition/metrics/{metricName}/facets
  • Auth
    none declared

Path parameters

envIdstring required

The unique ID of your environment

metricName'HTTP_REQUESTS' | 'HTTP_ERRORS' | 'HTTP_ERROR_RATE' | 'HTTP_REQUEST_CONTENT_LENGTH' | 'HTTP_RESPONSE_CONTENT_LENGTH' | 'HTTP_ENDPOINT_RESPONSE_TIME' | 'HTTP_GATEWAY_RESPONSE_TIME' | 'HTTP_GATEWAY_LATENCY' | 'LLM_PROMPT_TOKEN_SENT' | 'LLM_PROMPT_TOKEN_RECEIVED' | 'LLM_PROMPT_TOKEN_SENT_COST' | 'LLM_PROMPT_TOKEN_RECEIVED_COST' | 'LLM_PROMPT_TOTAL_TOKEN' | 'LLM_PROMPT_TOKEN_TOTAL_COST' | 'MESSAGE_PAYLOAD_SIZE' | 'MESSAGES' | 'MESSAGE_ERRORS' | 'MESSAGE_GATEWAY_LATENCY' | 'EDGE_DETECTION_COUNT' | 'EDGE_TOKENS_IN' | 'EDGE_TOKENS_OUT' | 'EDGE_HEARTBEAT_COUNT' | 'NATIVE_CONNECTIONS_SUMMARY' | 'NATIVE_MESSAGES_PRODUCED_DOWNSTREAM' | 'NATIVE_MESSAGES_PRODUCED_UPSTREAM' | 'NATIVE_MESSAGES_CONSUMED_DOWNSTREAM' | 'NATIVE_MESSAGES_CONSUMED_UPSTREAM' | 'NATIVE_BYTES_PRODUCED_DOWNSTREAM' | 'NATIVE_BYTES_PRODUCED_UPSTREAM' | 'NATIVE_BYTES_CONSUMED_DOWNSTREAM' | 'NATIVE_BYTES_CONSUMED_UPSTREAM' | 'NATIVE_ACTIVE_CONNECTIONS_DOWNSTREAM' | 'NATIVE_ACTIVE_CONNECTIONS_UPSTREAM' | 'NATIVE_AUTHENTICATIONS_SUCCESS_DOWNSTREAM' | 'NATIVE_AUTHENTICATIONS_SUCCESS_UPSTREAM' | 'NATIVE_AUTHENTICATIONS_FAILURE_DOWNSTREAM' | 'NATIVE_AUTHENTICATIONS_FAILURE_UPSTREAM' | 'NATIVE_OPERATIONS_RECEIVED' | 'NATIVE_OPERATIONS_FORWARDED' | 'NATIVE_OPERATIONS_ANSWERED' | 'NATIVE_OPERATIONS_COMPLETED' | 'NATIVE_OPERATION_GATEWAY_REQUEST_DURATION' | 'NATIVE_OPERATION_BROKER_DURATION' | 'NATIVE_OPERATION_GATEWAY_RESPONSE_DURATION' required

Available metric names for analytics queries

The metric identifier for which to retrieve filter specifications

Response

The response contains a list of available facets for the specified metric that can be used for grouping analytics data, including their data types.

Example response

{
  "data": [
    {
      "name": "API",
      "label": "API",
      "type": "KEYWORD"
    },
    {
      "name": "APPLICATION",
      "label": "Application",
      "type": "KEYWORD"
    },
    {
      "name": "GATEWAY",
      "label": "Gateway",
      "type": "KEYWORD"
    }
  ]
}

Changes

  • ff8d60356a08Revision changes
    • warning

      added the new NATIVE_CLIENT_ID enum value to the // response property for the response status

    • warning

      added the new NATIVE_FAILURE_SIDE enum value to the // response property for the response status

    • warning

      added the new NATIVE_OPERATION enum value to the // response property for the response status

    • warning

      added the new NATIVE_TOPIC enum value to the // response property for the response status

    • info

      added the new enum value NATIVE_ACTIVE_CONNECTIONS_DOWNSTREAM to the path request parameter metricName

    • info

      added the new enum value NATIVE_ACTIVE_CONNECTIONS_UPSTREAM to the path request parameter metricName

    • info

      added the new enum value NATIVE_AUTHENTICATIONS_FAILURE_DOWNSTREAM to the path request parameter metricName

    • info

      added the new enum value NATIVE_AUTHENTICATIONS_FAILURE_UPSTREAM to the path request parameter metricName

    • info

      added the new enum value NATIVE_AUTHENTICATIONS_SUCCESS_DOWNSTREAM to the path request parameter metricName

    • info

      added the new enum value NATIVE_AUTHENTICATIONS_SUCCESS_UPSTREAM to the path request parameter metricName

    • info

      added the new enum value NATIVE_BYTES_CONSUMED_DOWNSTREAM to the path request parameter metricName

    • info

      added the new enum value NATIVE_BYTES_CONSUMED_UPSTREAM to the path request parameter metricName

    • info

      added the new enum value NATIVE_BYTES_PRODUCED_DOWNSTREAM to the path request parameter metricName

    • info

      added the new enum value NATIVE_BYTES_PRODUCED_UPSTREAM to the path request parameter metricName

    • info

      added the new enum value NATIVE_MESSAGES_CONSUMED_DOWNSTREAM to the path request parameter metricName

    • info

      added the new enum value NATIVE_MESSAGES_CONSUMED_UPSTREAM to the path request parameter metricName

    • info

      added the new enum value NATIVE_MESSAGES_PRODUCED_DOWNSTREAM to the path request parameter metricName

    • info

      added the new enum value NATIVE_MESSAGES_PRODUCED_UPSTREAM to the path request parameter metricName

    • info

      added the new enum value NATIVE_OPERATIONS_ANSWERED to the path request parameter metricName

    • info

      added the new enum value NATIVE_OPERATIONS_COMPLETED to the path request parameter metricName

    • info

      added the new enum value NATIVE_OPERATIONS_FORWARDED to the path request parameter metricName

    • info

      added the new enum value NATIVE_OPERATIONS_RECEIVED to the path request parameter metricName

    • info

      added the new enum value NATIVE_OPERATION_BROKER_DURATION to the path request parameter metricName

    • info

      added the new enum value NATIVE_OPERATION_GATEWAY_REQUEST_DURATION to the path request parameter metricName

    • info

      added the new enum value NATIVE_OPERATION_GATEWAY_RESPONSE_DURATION to the path request parameter metricName

  • 6889427e4080Revision changes
    • warning

      added the new EDGE_MODEL enum value to the // response property for the response status

    • warning

      added the new EDGE_TOOL enum value to the // response property for the response status

    • warning

      added the new EDGE_TYPE enum value to the // response property for the response status

    • warning

      added the new EDGE_VERSION enum value to the // response property for the response status

    • info

      added the new enum value EDGE_HEARTBEAT_COUNT to the path request parameter metricName

    • info

      added the new enum value EDGE_TOKENS_IN to the path request parameter metricName

    • info

      added the new enum value EDGE_TOKENS_OUT to the path request parameter metricName