Skip to main content

MetricAggregation

The calculation done on the results of the query

Properties

NameTypeDescriptionNotes
namestrThe name of the metric aggregate to be included in the result. If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results.[required]
typeMetricType[optional] [default to MetricType.UNIQUE_COUNT]
var_fieldstrThe field the calculation is performed on. Prefix the field name with '@' to reference a nested object.[required]
}

Example

from sailpoint.v2024.models.metric_aggregation import MetricAggregation

metric_aggregation = MetricAggregation(
name='Access Name Count',
type='UNIQUE_COUNT',
var_field='@access.name'
)

[Back to top]