Metrics reference

A metric is a structure that specifies the type of event data captured in the report. See Metrics overview in the Adobe Analytics components user guide for details.

Calculated metrics

Calculated metrics are returned along with the other reporting API metrics. The IDs of these metrics are in the form f:<number>, where <number> is an integer. The metric type, decimal precision, and formula (where applicable) are included for all metrics.

Overtime-only metrics

Some metrics are only valid in overtime reports. Use Report.GetMetrics with the dateGranularity property to programmatically get a list of these metrics.

averagetimespentonsite
averagevisitdepth
customersdaily
customersloyal
customersmonthly
customersnew
customersquarterly
customersreturn
customersweekly
customersyearly
mobileviews
mobilevisitorsdaily
mobilevisits
returnvisits
returnvisitsdaily

If you try to run an overtime report on an unsupported metric, a metric_unsupported_in_overtime error occurs.

Permissions

Specific users may not have access to certain metrics. The metrics returned by Report.GetMetrics reflect those restrictions. Requesting a metric that one doesn't have permission to access will result in a metric_inaccessible error.

Metric object reference

A structure that defines a metric that appears in a report.

Element	Type	Description
`id`	`string`	The metric ID. This must match the metric ID specified in the report description.
`name`	`string`	The metric name.
`type`	`string`	The metric type. Valid values include `number` and `currency`.
`decimals`	`int`	The number of decimal places in the metric values.
`formula`	`string`	The formula if the metric is a calculated metric.
`latency`	`int`	Number of seconds the metric data is latent.
`current`	`boolean`	If `true`, contains the most recent data available as a result of the `currentData` flag set to `true` in `reportDescription`.

Metric ID reference

Metric	Category	Description
`carts` `totalCarts` `lifetimeCarts` `lifetimeTotalCarts` `participationCarts` `lifetimeParticipationCarts`	Commerce	The Carts metric.
`cartAdditions` `totalCartAdditions` `lifetimeCartAdditions` `lifetimeTotalCartAdditions` `participationCartAdditions` `lifetimeParticipationCartAdditions`	Commerce	The Cart additions metric.
`cartRemovals` `totalCartRemovals` `lifetimeCartRemovals` `lifetimeTotalCartRemovals` `participationCartRemovals` `lifetimeParticipationCartRemovals`	Commerce	The Cart removals metric.
`cartViews` `totalCartViews` `lifetimeCartViews` `lifetimeTotalCartViews` `participationCartViews` `lifetimeParticipationCartViews`	Commerce	The Cart views metric.
`checkouts` `totalCheckout` `lifetimeCheckout` `lifetimeTotalCheckouts` `participationCheckouts` `lifetimeParticipationCheckouts`	Commerce	The Checkouts metric.
`instances`	Commerce	The Instances metric.
`orders` `totalOrders` `lifetimeOrders` `lifetimeTotalOrders` `participationOrders` `lifetimeParticipationOrders`	Commerce	The Orders metric.
`units` `totalUnits` `lifetimeUnits` `lifetimeTotalUnits` `participationUnits` `lifetimeParticipationUnits`	Commerce	The Units metric.
`revenue` `totalRevenue` `lifetimeRevenue` `lifetimeTotalRevenue` `participationRevenue` `lifetimeParticipationRevenue`	Commerce	The Revenue metric.
`customersNew` `customersReturn` `customersLoyal` `customersDaily` `customersWeekly` `customersMonthly` `customersQuarterly` `customersYearly`	Commerce	Customer metrics.
`bounces`	Commerce	The Bounces metric.
`bounceRate`	Commerce	The Bounce rate metric.
`totalTimeSpent`	Commerce	The Total seconds spent metric.
`pathviews`	Commerce	Path views metric.
`event1`-`event1000`	Commerce	The respective Custom event.
`videotime` `videostart` `videocomplete` `videosegmentviews` `videoadstart` `videoadcomplete`	Commerce	Video metrics (commerce).
`pageViews` `totalPageViews`	Traffic	The Page views metric.
`visits` `totalVisits` `returnvisits` `returnvisitsdaily`	Traffic	The Visits metric.
`averageTimeSpentOnSite` `averageTimeSpentOnPage`	Traffic	The Average time on site metric.
`averagePageDepth` `averageVisitDepth`	Traffic	The Average page depth metric.
`visitors` `visitorsNew` `visitorsHourly` `totalVisitorsHourly` `visitorsDaily` `totalVisitorsDaily` `visitorsWeekly` `totalVisitorsWeekly` `visitorsMonthly` `totalVisitorsMonthly` `visitorsQuarterly` `totalVisitorsQuarterly` `visitorsYearly` `totalVisitorsYearly`	Traffic	Unique Visitors metrics.
`videoViews` `videoVisits` `videoVisitorsDaily`	Commerce	Video metrics (traffic).
`entries`	Traffic	The Entries metric.
`exits`	Traffic	The Exits metric.
`reloads`	Traffic	The Reloads metric.
`singleAccess`	Traffic	The Single access metric.
`bots`	Traffic	Bot traffic metric.

Dimensions

Segments

Last updated 2/1/2023

Was this helpful?

Yes