Skip to main content
Metrics

Metrics

Visualize your shop's average order value, orders per month and more customizable graphs

npm install @pinelab/vendure-plugin-metrics
Latest version3.0.0
Compatibility>=2.2.0
Last publishedSep 15, 2025
Pinelab
PinelabWebshops for mission-driven brands and wholesalers

Official documentation here

A plugin to visualize your shops most important metrics.

image

Getting started

  1. Configure the plugin in vendure-config.ts:
  1. Rebuild your Admin UI
  2. Run a database migration to add the necessary tables to your database.
  3. Start your Vendure server and login as administrator
  4. You should now be able to add the widget Advanced Metrics to your dashboard.

Metric results are cached in memory to prevent heavy database queries every time a user opens its dashboard.

Built-in Metrics

  1. Revenue (per product): The total revenue per month, or the revenue generated by specific variants if a variant is selected.
  2. Average Order Value (AOV): The average of order.totalWithTax of the orders per month
  3. Units sold: The number of units sold for the selected variant(s).

You can implement the MetricStrategy interface and pass it to the MetricsPlugin.init() function to have your custom metric visible in the Widget. Below is the implementation of the AOV metric, already included in the plugin, but it serves as an example of how to implement a custom metric.

Contributions

Special thanks to@dalyathan for his contributions on this plugin.