View

A View groups dashboard Widgets and can apply an analytics scope to their requests. Obtain a View from Metrix's Views service when integration code needs to inspect or change that scope:

use verbb\metrix\Metrix;

$views = Metrix::$plugin->getViews();
$view = $views->getViewByHandle('mainDashboard');

if (!$view) {
    throw new \RuntimeException('The mainDashboard Metrix View does not exist.');
}

Properties

Analytics Scope

Views can optionally scope every widget fetch to a Craft site, path prefix, or hostname. That is stored under settings.analyticsScope and applied by providers that support it (Google Analytics, Plausible path filters, Matomo segments).

When a Craft site is selected, Metrix derives the filter from the site’s base URL: a different host than the primary site becomes a hostname filter; a shared root URL becomes a path-prefix filter.

For separate analytics properties/domains, continue to use separate Sources — View scope is for one property covering multiple Craft sites.

Methods

The following example restricts the View to analytics paths beginning with /shop:

use verbb\metrix\models\AnalyticsScope;

$view->setAnalyticsScope([
    'mode' => AnalyticsScope::MODE_PATH,
    'pathPrefix' => '/shop',
]);

$views->saveView($view);