Service metrics API - JSON models

Some JSON models of the Calculated service metrics API vary according to the type of some objects. Here you can find JSON models for each variation.

Variations of the ComparisonInfo object

BOOLEAN

The BooleanComparisonInfo object

Comparison for BOOLEAN attributes.

Element
Type
Description
comparison
string

Operator of the comparision. You can reverse it by setting negate to true.

  • EQUALS
  • EQUALS_ANY_OF
  • EXISTS
value
boolean

The value to compare to.

values
boolean[]

The values to compare to.

ESB_INPUT_NODE_TYPE

The ESBInputNodeTypeComparisonInfo object

Type-specific comparison information for attributes of type 'ESB_INPUT_NODE_TYPE'.This model also inherits fields from the parent model ComparisonInfo.

Element
Type
Description
comparison
string

Operator of the comparision. You can reverse it by setting negate to true.

  • EQUALS
  • EQUALS_ANY_OF
  • EXISTS
value
string

The value to compare to.

  • CALLABLE_FLOW_ASYNC_RESPONSE_NODE
  • CALLABLE_FLOW_INPUT_NODE
  • DATABASE_INPUT_NODE
  • DOTNET_INPUT_NODE
  • EMAIL_INPUT_NODE
  • EVENT_INPUT
  • EVENT_INPUT_NODE
  • FILE_INPUT_NODE
  • FTE_INPUT_NODE
  • HTTP_ASYNC_RESPONSE
  • JD_EDWARDS_INPUT_NODE
  • JMS_CLIENT_INPUT_NODE
  • LABEL_NODE
  • MQ_INPUT_NODE
  • PEOPLE_SOFT_INPUT_NODE
  • REST_ASYNC_RESPONSE
  • REST_REQUEST
  • SAP_INPUT_NODE
  • SCA_ASYNC_RESPONSE_NODE
  • SCA_INPUT_NODE
  • SIEBEL_INPUT_NODE
  • SOAP_INPUT_NODE
  • TCPIP_CLIENT_INPUT_NODE
  • TCPIP_CLIENT_REQUEST_NODE
  • TCPIP_SERVER_INPUT_NODE
  • TCPIP_SERVER_REQUEST_NODE
  • TIMEOUT_NOTIFICATION_NODE
  • WS_INPUT_NODE
values
string[]

The values to compare to.

  • CALLABLE_FLOW_ASYNC_RESPONSE_NODE
  • CALLABLE_FLOW_INPUT_NODE
  • DATABASE_INPUT_NODE
  • DOTNET_INPUT_NODE
  • EMAIL_INPUT_NODE
  • EVENT_INPUT
  • EVENT_INPUT_NODE
  • FILE_INPUT_NODE
  • FTE_INPUT_NODE
  • HTTP_ASYNC_RESPONSE
  • JD_EDWARDS_INPUT_NODE
  • JMS_CLIENT_INPUT_NODE
  • LABEL_NODE
  • MQ_INPUT_NODE
  • PEOPLE_SOFT_INPUT_NODE
  • REST_ASYNC_RESPONSE
  • REST_REQUEST
  • SAP_INPUT_NODE
  • SCA_ASYNC_RESPONSE_NODE
  • SCA_INPUT_NODE
  • SIEBEL_INPUT_NODE
  • SOAP_INPUT_NODE
  • TCPIP_CLIENT_INPUT_NODE
  • TCPIP_CLIENT_REQUEST_NODE
  • TCPIP_SERVER_INPUT_NODE
  • TCPIP_SERVER_REQUEST_NODE
  • TIMEOUT_NOTIFICATION_NODE
  • WS_INPUT_NODE

FAILED_STATE

The FailedStateComparisonInfo object

Comparison for FAILED_STATE attributes.

Element
Type
Description
comparison
string

Operator of the comparision. You can reverse it by setting negate to true.

  • EQUALS
  • EQUALS_ANY_OF
  • EXISTS
value
string

The value to compare to.

  • FAILED
  • SUCCESSFUL
values
string[]

The values to compare to.

  • FAILED
  • SUCCESSFUL

FAILURE_REASON

The FailureReasonComparisonInfo object

Comparison for FAILURE_REASON attributes.

Element
Type
Description
comparison
string

Operator of the comparision. You can reverse it by setting negate to true.

  • EQUALS
  • EQUALS_ANY_OF
  • EXISTS
value
string

The value to compare to.

  • EXCEPTION_AT_ENTRY_NODE
  • EXCEPTION_ON_ANY_NODE
  • HTTP_CODE
  • REQUEST_ATTRIBUTE
  • SPAN_FAILURE
values
string[]

The values to compare to.

  • EXCEPTION_AT_ENTRY_NODE
  • EXCEPTION_ON_ANY_NODE
  • HTTP_CODE
  • REQUEST_ATTRIBUTE
  • SPAN_FAILURE

FAST_STRING

The FastStringComparisonInfo object

Comparison for FAST_STRING attributes. Use it for all service property attributes.

Element
Type
Description
caseSensitive
boolean

The comparison is case-sensitive (true) or not case-sensitive (false).

comparison
string

Operator of the comparision. You can reverse it by setting negate to true.

  • CONTAINS
  • EQUALS
  • EQUALS_ANY_OF
value
string

The value to compare to.

values
string[]

The values to compare to.

FLAW_STATE

The FlawStateComparisonInfo object

Comparison for FLAW_STATE attributes.

Element
Type
Description
comparison
string

Operator of the comparision. You can reverse it by setting negate to true.

  • EQUALS
  • EQUALS_ANY_OF
  • EXISTS
value
string

The value to compare to.

  • FLAWED
  • NOT_FLAWED
values
string[]

The values to compare to.

  • FLAWED
  • NOT_FLAWED

HTTP_METHOD

The HttpMethodComparisonInfo object

Comparison for HTTP_METHOD attributes.

Element
Type
Description
comparison
string

Operator of the comparision. You can reverse it by setting negate to true.

  • EQUALS
  • EQUALS_ANY_OF
  • EXISTS
value
string

The value to compare to.

  • CONNECT
  • DELETE
  • GET
  • HEAD
  • OPTIONS
  • PATCH
  • POST
  • PUT
  • TRACE
  • UNKNOWN
values
string[]

The values to compare to.

  • CONNECT
  • DELETE
  • GET
  • HEAD
  • OPTIONS
  • PATCH
  • POST
  • PUT
  • TRACE
  • UNKNOWN

HTTP_STATUS_CLASS

The HttpStatusClassComparisonInfo object

Comparison for HTTP_STATUS_CLASS attributes.

Element
Type
Description
comparison
string

Operator of the comparision. You can reverse it by setting negate to true.

  • EQUALS
  • EQUALS_ANY_OF
  • EXISTS
value
string

The value to compare to.

  • C_1XX
  • C_2XX
  • C_3XX
  • C_4XX
  • C_5XX
  • NO_RESPONSE
values
string[]

The values to compare to.

  • C_1XX
  • C_2XX
  • C_3XX
  • C_4XX
  • C_5XX
  • NO_RESPONSE

IIB_INPUT_NODE_TYPE

The IIBInputNodeTypeComparisonInfo object

Comparison for IIB_INPUT_NODE_TYPE attributes.

Element
Type
Description
comparison
string

Operator of the comparision. You can reverse it by setting negate to true.

  • EQUALS
  • EQUALS_ANY_OF
  • EXISTS
value
string

The value to compare to.

  • CALLABLE_FLOW_ASYNC_RESPONSE_NODE
  • CALLABLE_FLOW_INPUT_NODE
  • DATABASE_INPUT_NODE
  • DOTNET_INPUT_NODE
  • EMAIL_INPUT_NODE
  • EVENT_INPUT
  • EVENT_INPUT_NODE
  • FILE_INPUT_NODE
  • FTE_INPUT_NODE
  • HTTP_ASYNC_RESPONSE
  • JD_EDWARDS_INPUT_NODE
  • JMS_CLIENT_INPUT_NODE
  • LABEL_NODE
  • MQ_INPUT_NODE
  • PEOPLE_SOFT_INPUT_NODE
  • REST_ASYNC_RESPONSE
  • REST_REQUEST
  • SAP_INPUT_NODE
  • SCA_ASYNC_RESPONSE_NODE
  • SCA_INPUT_NODE
  • SIEBEL_INPUT_NODE
  • SOAP_INPUT_NODE
  • TCPIP_CLIENT_INPUT_NODE
  • TCPIP_CLIENT_REQUEST_NODE
  • TCPIP_SERVER_INPUT_NODE
  • TCPIP_SERVER_REQUEST_NODE
  • TIMEOUT_NOTIFICATION_NODE
  • WS_INPUT_NODE
values
string[]

The values to compare to.

  • CALLABLE_FLOW_ASYNC_RESPONSE_NODE
  • CALLABLE_FLOW_INPUT_NODE
  • DATABASE_INPUT_NODE
  • DOTNET_INPUT_NODE
  • EMAIL_INPUT_NODE
  • EVENT_INPUT
  • EVENT_INPUT_NODE
  • FILE_INPUT_NODE
  • FTE_INPUT_NODE
  • HTTP_ASYNC_RESPONSE
  • JD_EDWARDS_INPUT_NODE
  • JMS_CLIENT_INPUT_NODE
  • LABEL_NODE
  • MQ_INPUT_NODE
  • PEOPLE_SOFT_INPUT_NODE
  • REST_ASYNC_RESPONSE
  • REST_REQUEST
  • SAP_INPUT_NODE
  • SCA_ASYNC_RESPONSE_NODE
  • SCA_INPUT_NODE
  • SIEBEL_INPUT_NODE
  • SOAP_INPUT_NODE
  • TCPIP_CLIENT_INPUT_NODE
  • TCPIP_CLIENT_REQUEST_NODE
  • TCPIP_SERVER_INPUT_NODE
  • TCPIP_SERVER_REQUEST_NODE
  • TIMEOUT_NOTIFICATION_NODE
  • WS_INPUT_NODE

NUMBER

The NumberComparisonInfo object

Comparison for NUMBER attributes.

Element
Type
Description
comparison
string

Operator of the comparision. You can reverse it by setting negate to true.

  • EQUALS
  • EQUALS_ANY_OF
  • EXISTS
  • GREATER_THAN
  • GREATER_THAN_OR_EQUAL
  • LOWER_THAN
  • LOWER_THAN_OR_EQUAL
value
number

The value to compare to.

values
number[]

The values to compare to.

NUMBER_REQUEST_ATTRIBUTE

The NumberRequestAttributeComparisonInfo object

Comparison for NUMBER_REQUEST_ATTRIBUTE attributes, specifically of the generic Number type.

Element
Type
Description
comparison
string

Operator of the comparision. You can reverse it by setting negate to true.

  • EQUALS
  • EQUALS_ANY_OF
  • EXISTS
  • GREATER_THAN
  • GREATER_THAN_OR_EQUAL
  • LOWER_THAN
  • LOWER_THAN_OR_EQUAL
matchOnChildCalls
boolean

If true, the request attribute is matched on child service calls.

Default is false.

requestAttribute
string
-
source

Defines valid sources of request attributes for conditions or placeholders.

value
number

The value to compare to.

values
number[]

The values to compare to.

The PropagationSource object

Defines valid sources of request attributes for conditions or placeholders.

Element
Type
Description
managementZone
string

Use only request attributes from services that belong to this management zone.. Use either this or serviceTag

serviceTag

Use only request attributes from services that have this tag. Use either this or managementZone

The UniversalTag object

Use only request attributes from services that have this tag. Use either this or managementZone

Element
Type
Description
context
string

The origin of the tag, such as AWS or Cloud Foundry. For custom tags use the CONTEXTLESS value.

The context is set for tags that are automatically imported by OneAgent (for example, from the AWS console or environment variables). It’s useful for determining the origin of tags when not manually defined, and it also helps to prevent clashes with other existing tags. If the tag is not automatically imported, CONTEXTLESS set.

  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_COMPUTE_ENGINE
  • KUBERNETES
key
string

The key of the tag. For custom tags, put the tag value here.

The key allows categorization of multiple tags. It is possible that there are multiple values for a single key which will all be represented as standalone tags. Therefore, the key does not have the semantic of a map key but is more like a key of a key-value tuple. In some cases, for example custom tags, the key represents the actual tag value and the value field is not set – those are called valueless tags.

value
string

The value of the tag. Not applicable to custom tags.

If a tag does have a separate key and value (in the textual representation they are split by the colon ‘:’), this field is set with the actual value. Key-value pairs can occur for automatically imported tags and tags set by rules if extractors are used.

The UniversalTagKey object

Element
Type
Description
context
string
-
  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_COMPUTE_ENGINE
  • KUBERNETES
key
string
-

SERVICE_TYPE

The ServiceTypeComparisonInfo object

Comparison for SERVICE_TYPE attributes.

Element
Type
Description
comparison
string

Operator of the comparision. You can reverse it by setting negate to true.

  • EQUALS
  • EQUALS_ANY_OF
  • EXISTS
value
string

The value to compare to.

  • BACKGROUND_ACTIVITY
  • CICS_SERVICE
  • CUSTOM_SERVICE
  • DATABASE_SERVICE
  • ENTERPRISE_SERVICE_BUS_SERVICE
  • EXTERNAL
  • IBM_INTEGRATION_BUS_SERVICE
  • IMS_SERVICE
  • MESSAGING_SERVICE
  • RMI_SERVICE
  • RPC_SERVICE
  • SPAN_SERVICE
  • UNIFIED_SERVICE
  • WEB_REQUEST_SERVICE
  • WEB_SERVICE
  • ZOS_CONNECT_SERVICE
values
string[]

The values to compare to.

  • BACKGROUND_ACTIVITY
  • CICS_SERVICE
  • CUSTOM_SERVICE
  • DATABASE_SERVICE
  • ENTERPRISE_SERVICE_BUS_SERVICE
  • EXTERNAL
  • IBM_INTEGRATION_BUS_SERVICE
  • IMS_SERVICE
  • MESSAGING_SERVICE
  • RMI_SERVICE
  • RPC_SERVICE
  • SPAN_SERVICE
  • UNIFIED_SERVICE
  • WEB_REQUEST_SERVICE
  • WEB_SERVICE
  • ZOS_CONNECT_SERVICE

STRING

The StringComparisonInfo object

Comparison for STRING attributes.

Element
Type
Description
caseSensitive
boolean

The comparison is case-sensitive (true) or not case-sensitive (false).

comparison
string

Operator of the comparision. You can reverse it by setting negate to true.

  • BEGINS_WITH
  • BEGINS_WITH_ANY_OF
  • CONTAINS
  • ENDS_WITH
  • ENDS_WITH_ANY_OF
  • EQUALS
  • EQUALS_ANY_OF
  • EXISTS
  • REGEX_MATCHES
value
string

The value to compare to.

values
string[]

The values to compare to.

STRING_REQUEST_ATTRIBUTE

The StringRequestAttributeComparisonInfo object

Comparison for STRING_REQUEST_ATTRIBUTE attributes, specifically of the String type.

Element
Type
Description
caseSensitive
boolean

The comparison is case-sensitive (true) or not case-sensitive (false).

comparison
string

Operator of the comparision. You can reverse it by setting negate to true.

  • BEGINS_WITH
  • BEGINS_WITH_ANY_OF
  • CONTAINS
  • ENDS_WITH
  • ENDS_WITH_ANY_OF
  • EQUALS
  • EQUALS_ANY_OF
  • EXISTS
  • REGEX_MATCHES
matchOnChildCalls
boolean

If true, the request attribute is matched on child service calls.

Default is false.

requestAttribute
string
-
source

Defines valid sources of request attributes for conditions or placeholders.

value
string

The value to compare to.

values
string[]

The values to compare to.

The PropagationSource object

Defines valid sources of request attributes for conditions or placeholders.

Element
Type
Description
managementZone
string

Use only request attributes from services that belong to this management zone.. Use either this or serviceTag

serviceTag

Use only request attributes from services that have this tag. Use either this or managementZone

The UniversalTag object

Use only request attributes from services that have this tag. Use either this or managementZone

Element
Type
Description
context
string

The origin of the tag, such as AWS or Cloud Foundry. For custom tags use the CONTEXTLESS value.

The context is set for tags that are automatically imported by OneAgent (for example, from the AWS console or environment variables). It’s useful for determining the origin of tags when not manually defined, and it also helps to prevent clashes with other existing tags. If the tag is not automatically imported, CONTEXTLESS set.

  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_COMPUTE_ENGINE
  • KUBERNETES
key
string

The key of the tag. For custom tags, put the tag value here.

The key allows categorization of multiple tags. It is possible that there are multiple values for a single key which will all be represented as standalone tags. Therefore, the key does not have the semantic of a map key but is more like a key of a key-value tuple. In some cases, for example custom tags, the key represents the actual tag value and the value field is not set – those are called valueless tags.

value
string

The value of the tag. Not applicable to custom tags.

If a tag does have a separate key and value (in the textual representation they are split by the colon ‘:’), this field is set with the actual value. Key-value pairs can occur for automatically imported tags and tags set by rules if extractors are used.

The UniversalTagKey object

Element
Type
Description
context
string
-
  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_COMPUTE_ENGINE
  • KUBERNETES
key
string
-

TAG

The TagComparisonInfo object

Comparison for TAG attributes.

Element
Type
Description
comparison
string

Operator of the comparision. You can reverse it by setting negate to true.

  • EQUALS
  • EQUALS_ANY_OF
  • TAG_KEY_EQUALS
  • TAG_KEY_EQUALS_ANY_OF
value

Tag of a Dynatrace entity.

values

The values to compare to.

The TagInfo object

Tag of a Dynatrace entity.

Element
Type
Description
context
string

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_CLOUD
  • KUBERNETES
key
string

The key of the tag.

Custom tags have the tag value here.

value
string

The value of the tag.

Not applicable to custom tags.

ZOS_CALL_TYPE

The ZosComparisonInfo object

Comparison for ZOS_CALL_TYPE attributes.

Element
Type
Description
comparison
string

Operator of the comparision. You can reverse it by setting negate to true.

  • EQUALS
  • EQUALS_ANY_OF
  • EXISTS
value
string

The value to compare to.

  • CTG
  • DPL
  • EXPLICIT_ADK
  • HTTP
  • IMS_CONNECT
  • IMS_CONNECT_API
  • IMS_ITRA
  • IMS_MSC
  • IMS_PGM_SWITCH
  • IMS_SHARED_QUEUES
  • IMS_TRANS_EXEC
  • MQ
  • SOAP
  • START
  • TTX
  • TX
  • UNKNOWN
  • ZOS_CONNECT
values
string[]

The values to compare to.

  • CTG
  • DPL
  • EXPLICIT_ADK
  • HTTP
  • IMS_CONNECT
  • IMS_CONNECT_API
  • IMS_ITRA
  • IMS_MSC
  • IMS_PGM_SWITCH
  • IMS_SHARED_QUEUES
  • IMS_TRANS_EXEC
  • MQ
  • SOAP
  • START
  • TTX
  • TX
  • UNKNOWN
  • ZOS_CONNECT