Settings API - User action custom metrics schema table

User action custom metrics (builtin:user-action-custom-metrics)

With user action custom metrics (see documentation), you can extract business-level KPI metrics from user action data. Metrics can then be saved as timeseries and consumed (without interpolation) by your custom charts, alerting mechanisms or the Metrics REST API (<your-dynatrace-url>//rest-api-doc/?urls.primaryName=Environment+API+v2#/Metrics).

To explore collected metrics, go to Data explorer (<your-dynatrace-url>//ui/data-explorer).

To create a custom event based on a custom metric, go to Custom events for alerting (<your-dynatrace-url>//#settings/anomalydetection/metricevents).

Schema IDSchema groupsScope
builtin:user-action-custom-metrics
  • group:web-and-mobile-monitoring
  • group:web-and-mobile-monitoring.usql-custom-metrics
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:user-action-custom-metrics
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:user-action-custom-metrics
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:user-action-custom-metrics

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyTypeDescriptionRequired
Enable custom metric
enabled		boolean-required
Metric key
metricKey		text-required
Value type to be extracted
value		MetricValue

Defines the type of value to be extracted from the user action. When using user action counter, the number of user actions is counted (similar to count(*) when using USQL). When using user action field value, the value of a user action field is extracted.

required
Add a dimension
dimensions		list

Defines the fields that are used as dimensions. A dimension is a collection of reference information about a metric data point that is of interest to your business. Dimensions are parameters like "application", "type", "apdexCategory". For example, using "type" as a dimension allows you to split chart data based on the user action type.

required
Add a filter
filters		Filter[]

Defines the filters for the user action. Filters apply at the moment of extracting the data and only sessions that satisfy the filtering criteria will be used to extract the custom metrics. You will not be able to modify these filters in the metric data explorer. For example, using "type equals Xhr" will give you only data from xhr actions, while forcing the rest of user actions of different types to be ignored.

required
The MetricValue object
PropertyTypeDescriptionRequired
typeenum
  • COUNTER
  • FIELD
required
Field name
fieldName		text-required
The Filter object
PropertyTypeDescriptionRequired
Field name
fieldName		text-required
Operator
operator		enum
  • EQUALS
  • NOT_EQUAL
  • IS_NULL
  • IS_NOT_NULL
  • LIKE
  • NOT_LIKE
  • LESS_THAN
  • LESS_THAN_OR_EQUAL_TO
  • GREATER_THAN
  • GREATER_THAN_OR_EQUAL_TO
  • IN
  • STARTS_WITH
required
Value
value		text-required
Values
valueIn		list-required