Settings API - User action custom metrics schema table
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 (
To explore collected metrics, go to Data explorer (
To create a custom event based on a custom metric, go to Custom events for alerting (
|Schema ID||Schema groups||Scope|
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.
|enabled||Enable custom metric||boolean||-||required|
|value||Value type to be extracted||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.
|dimensions||Add a dimension||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.
|filters||Add a filter||list|
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.
Request body objects