CalculatedMetrics
Retrieve a list of all calculated metrics defined within your Adobe Analytics environment, including custom formulas built on top of standard metrics.
View-Specific Information
SELECT
The CalculatedMetrics view supports only a subset of columns for server-side filtering. Below is a table containing those columns with their supported operators.| Column | Supported Operators |
| Id | =, IN |
| Name | =, CONTAINS, LIKE |
| OwnerId | = |
| IncludeType | = |
| ToBeUsedInRsid | = |
| TagNames | = |
| Approved | = |
| Locale | = |
The LIKE operator is pushed to the server only for substring patterns of the form '%...%'. Other patterns are evaluated client-side.
The IN operator on the Id column is sent as a single batched request using the Adobe Analytics API's filterByIds parameter.
For example, the following queries are processed server-side:
SELECT * FROM CalculatedMetrics WHERE Id = 'cm300012345_1234567890'
SELECT * FROM CalculatedMetrics WHERE IncludeType = 'all' AND Name CONTAINS 'Revenue'
SELECT * FROM CalculatedMetrics WHERE IncludeType = 'all' AND Name LIKE '%Bounce%'
SELECT * FROM CalculatedMetrics WHERE Id IN ('cm300012345_1234567890', 'cm300012345_0987654321')
Columns
| Name | Type | IsDimension | IsMetric | DefaultDimension | DefaultMetric | Description |
| Id [KEY] | String | System-assigned unique ID used to reference the calculated metric in API calls, queries, or configuration files. | ||||
| Name | String | Descriptive label for the calculated metric, used in dashboards, reports, and metric selectors. | ||||
| ReportSuiteName | String | Name of the Adobe Analytics report suite in which the calculated metric is defined. | ||||
| Description | String | Clarifies the metric's purpose, formula logic, and how it contributes to business analysis. | ||||
| Created | Datetime | Timestamp of when the calculated metric was first created within Adobe Analytics. | ||||
| Modified | Datetime | Timestamp of the last modification to the metric's configuration, logic, or metadata. | ||||
| Type | String | Data type used to format the calculated metric's output. Common values: int, decimal, percentage, currency. | ||||
| OwnerId | String | ID of the Adobe Analytics user who originally created the calculated metric. | ||||
| OwnerName | String | Full name of the user listed as the creator and owner of the metric. | ||||
| Category | String | User-defined tag or folder used to categorize the calculated metric for easier management. | ||||
| SiteTitle | String | Title of the website or digital asset linked to the report suite where this metric is used. | ||||
| Polarity | String | Indicates whether a higher value for the metric is favorable or unfavorable. Valid values: positive, negative. | ||||
| Precision | Integer | Controls the number of digits displayed after the decimal point for the metric in reports. | ||||
| Template | String | Template ID used to generate this metric from a predefined calculation blueprint. Applies only when IncludeType = templates. | ||||
| ToBeUsedInRsid | String | Filter calculated metrics that are available for use in the specified report suite, including shared or global metrics created elsewhere. | ||||
| TagNames | String | A comma-separated list of tag names. Only metrics with all specified tags are returned. | ||||
| Locale | String | The locale for localized name and description fields. For example, en_US or fr_FR. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| IncludeType | String | Determines which types of calculated metrics to return. Options: all (all company metrics), shared (metrics shared with the user), and templates (metric templates only). |
| Approved | Boolean | Filter for only approved calculated metrics. |