--- sourceDocument: Australia Telecom Service Operations Management sourceDocumentLink: https://www.servicenow.com/docs/r/australia/telecom-service-ops Release : - australia ft:locale : - en-US ft:publication_title : - Australia Telecom Service Operations Management ft:clusterId : - tsom bundleId : - tsom workflow : - Customer and Industry --- # Metric aggregation configuration reference # Metric aggregation configuration reference {#ariaid-title1} Release version: Australia Updated November 5, 2026 ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read Summarize ![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete. ## Summary of Metric aggregation configuration reference This reference details the configuration object used in the metric aggregation scripted extension point within ServiceNow. It defines which metrics to aggregate, the aggregation method, and where to publish the resulting calculated metric. The configuration varies based on the aggregation mode---eitherhierarchyorflat. Show full answer Show less ## Key Features * **Aggregation Modes:** * **Hierarchy mode:** Aggregates metrics by traversing CMDB relationships downward from target configuration items (CIs). * **Flat mode:** Aggregates metrics tied to an anchor CI without hierarchical traversal. * **Configuration Parameters:** * **mode:** Specifies aggregation mode (`hierarchy` or `flat`), required for all configurations. * **targetCIClass:** Required in hierarchy mode; CMDB class of the parent or target CI receiving the calculated metric. * **sourceCIClass:** Required; CMDB class of source CIs providing raw metrics. * **sourceMetric:** Required; name of the raw metric collected on source CIs for aggregation. * **aggregate:** Required; aggregation function such as `avg`, `sum`, `max`, `min`, `count`, or `p95`. * **calculatedMetricName:** Required; name of the resulting calculated metric. * **unit:** Optional; unit label for the calculated metric (e.g., Mbps). * **level:** Optional hierarchy depth limit for CMDB traversal; defaults to 4 and capped at 20. * **rangeStart** and **rangeEnd:** Optional; define contiguous ranges of source CIs by name for selection. * **filters:** Optional; array of field filters to restrict source CIs by specific conditions. * **anchorCiSysId:** Required in flat mode; sysid of the anchor CI holding the calculated metric. * **Filters:** Used to narrow source CIs based on field conditions with operators such as =, !=, \>, CONTAINS, IN, etc. ## Practical Application for ServiceNow Customers By configuring metric aggregation appropriately, customers can consolidate raw metrics from various CIs into meaningful calculated metrics. This enables monitoring and reporting at different CMDB hierarchy levels or attached to specific anchor CIs. The flexibility in aggregation modes, filtering, and range selection allows precise control over what data is aggregated and where results are published, facilitating performance tracking, capacity planning, and operational insights. The configuration object passed to the metric aggregation scripted extension point defines what to aggregate, how to aggregate it, and where to publish the result. The parameters that apply depend on the aggregation mode. ## Configuration parameters {#metric-aggregation-configuration-reference__section_parameters} {#metric-aggregation-configuration-reference__table_aggregation_parameters__entry__5} | Parameter | Type | Applies to mode | Required | Description | |-|-|-|-|-| | `mode` | String | Both | Required | Aggregation mode. One of `hierarchy` or `flat`. The mode determines how source resources are selected and where the calculated metric is published. See [Metric aggregation modes](https://www.servicenow.com/docs/2jV5JoVOpHxx7cKC_051Yw "Metric aggregation rolls up raw metrics collected from individual network resources into calculated metrics on parent or anchor configuration items (CIs). The aggregation mode determines how source resources are selected and where the aggregated result is published."). | | `targetCIClass` | String | Hierarchy | Required (hierarchy) | CMDB class of the parent or target CI that receives the calculated metric, for example `cmdb_ci_baseband_unit`. The aggregation traverses CMDB relationships downward from each target CI to collect the matching source CIs. | | `sourceCIClass` | String | Both | Required | CMDB class of the source CIs whose raw metric is aggregated, for example `cmdb_ci_mobile_cell`. | | `sourceMetric` | String | Both | Required | Name of the raw metric collected on the source CIs that is read as input to the aggregation. | | `aggregate` | String | Both | Required | Aggregate function applied to the source metric values. One of `avg`, `sum`, `max`, `min`, `count`, or `p95`. The calculated value is stored unrounded, as a raw floating-point number. | | `calculatedMetricName` | String | Both | Required | Name of the calculated metric that the aggregation produces and publishes. | | `unit` | String | Both | Optional | Unit label applied to the calculated metric, for example `Mbps`. | | `level` | Integer | Hierarchy | Optional | Depth limit that bounds how far the CMDB traversal descends from each target CI. Prevents the traversal from following relationships beyond the resources you intend to aggregate. Defaults to `4` and is capped at a maximum of `20`; larger values are silently capped. A value of `0` is not treated as "no traversal" --- it falls back to the default of `4`. | | `rangeStart` | String | Both | Optional | Start of a contiguous range of source resources identified by name, for example `SIM010`. Use with `rangeEnd` to select source CIs by range. | | `rangeEnd` | String | Both | Optional | End of the contiguous range of source resources identified by name, for example `SIM050`. | | `filters` | Array | Both | Optional | Field filters that restrict the source CIs to those meeting a condition. Each element is an object with `field`, `operator`, and `value`. See [Filter object](https://www.servicenow.com/docs/F5Ih3JFaVTsMXmn93Tme4A#metric-aggregation-configuration-reference__table_filter_object). | | `anchorCiSysId` | String | Flat | Required (flat) | The `sys_id` of the anchor CI that holds the calculated metric. In flat mode the result is not tied to an existing parent CI, so you specify an anchor CI to hold it. | [Table 1. Metric aggregation configuration parameters] {#metric-aggregation-configuration-reference__table_aggregation_parameters} ## Filter object {#metric-aggregation-configuration-reference__section_filter_object} Each element of the `filters` array selects source CIs that meet a single field condition. {#metric-aggregation-configuration-reference__table_filter_object__entry__3} | Property | Type | Description | |-|-|-| | `field` | String | Name of the field on the source CI to evaluate, for example `operational_status`. | | `operator` | String | Comparison operator applied to the field. One of `=`, `!=`, `>`, `>=`, `<`, `<=`, `CONTAINS`, `STARTSWITH`, or `IN`. | | `value` | String | Value the field is compared against, for example `1`. | [Table 2. Filter object properties] {#metric-aggregation-configuration-reference__table_filter_object} **Related concepts** * [Metric aggregation modes](https://www.servicenow.com/docs/2jV5JoVOpHxx7cKC_051Yw "Metric aggregation rolls up raw metrics collected from individual network resources into calculated metrics on parent or anchor configuration items (CIs). The aggregation mode determines how source resources are selected and where the aggregated result is published.") **Related tasks** * [Configure a metric aggregation job](https://www.servicenow.com/docs/n2HcANnpIL8MnmKqroJVgw "Configure a scheduled job to aggregate raw metrics into a calculated metric on a parent or anchor configuration item (CI). Aggregated metrics let you view performance data at a higher level of the network.") **Related reference** * [Metric type IDs](https://www.servicenow.com/docs/EykiIeBowcDjYGzTfVFhUw "Metric type IDs identify each time-series metric that a connector writes to the metrics database. Use these IDs to locate metrics in Insights Explorer or when you build custom dashboards and indicators.")