silvershop-suite / analytics

1.2.0 2026-10-19 18:05 UTC

Requires

• php: ^8.3
• silvershop/core: ^6
• silverstripe/framework: ^6.0
• silverstripe/reports: ^6.0

Requires (Dev)

• phpunit/phpunit: ^11.3
• silverstripe/sqlite3: ^4
• squizlabs/php_codesniffer: ^3.7

BSD-3-Clause

• Remy Vaartjes
• SilverShop-Suite Contributors

• ecommerce
• analytics
• silverstripe
• reports
• silvershop
• most-viewed

Published on Packagist.org on 2026-10-19 19:25 UTC

README

Catalog analytics for SilverShop (Silverstripe CMS 6).

This first release ships product-view tracking and a Most-viewed products report. It is built so that search-term reporting can be added later without a redesign (see Roadmap).

Requirements

• Silverstripe CMS ^6.0
• SilverShop core ^6
• silverstripe/reports ^6.0

Installation

composer require silvershop-suite/analytics

Then run dev/build?flush=1.

What it does

• Records one anonymous row per product-page view (SilverShop_ProductView).
• Adds a Shop → Most-viewed products report (Reports admin) with view counts and unique-viewer counts over a date range.
• Ships a prune task to keep the raw log bounded.

Tracking attaches to SilverShop\Page\ProductController and fires only on the product page's own GET request — never on form posts, ajax calls, or sub-actions — so counts reflect genuine page views.

Privacy

No raw PII is stored:

• Unique viewers are counted from a one-way hash (sha1) of an anonymous per-session token minted on the first view — never an IP address or a login.
• The member link is off by default (track_members: false); enable it only if you want views attributed to logged-in members.
• Set respect_consent: true to gate tracking behind a cookie-consent flag in the session, so the module can sit behind a consent banner.

# app/_config/analytics.yml
SilverShop\Analytics\Extension\ProductViewTrackingExtension:
  enabled: true            # master switch
  track_members: false     # attribute views to logged-in members
  respect_consent: false   # only track once the consent flag is set
  consent_session_key: 'analytics_consent'

Retention

The report reads the raw view log directly, so figures are live with no rollup to run. Raw rows are pruned after retention_days (default 365) — this also bounds how far back the report can look.

SilverShop\Analytics\Model\ProductView:
  retention_days: 365      # 0 disables pruning

Schedule the prune task daily (cron or symbiote/silverstripe-queuedjobs):

vendor/bin/sake tasks:SilverShop-Analytics-Task-PruneProductViewsTask

Search-term tracking

Exposes SilverShop\Analytics\SearchInsights::record($term, $resultCount) — a search module (e.g. silvershop-suite/search) calls it on every query, which stores a normalised SearchLog row and powers two reports:

• Top search terms — most frequent searches and their average result count.
• Zero-result searches — queries that returned nothing (merchandising / SEO gold).

Terms are lower-cased and whitespace-collapsed so variants aggregate. No PII is stored; the member link is off unless SearchInsights.track_members is enabled, and rows prune after SearchLog.retention_days (via PruneSearchLogTask). silvershop-suite/search wires this automatically when both modules are installed.

SilverShop\Analytics\SearchInsights:
  enabled: true
  track_members: false
SilverShop\Analytics\Model\SearchLog:
  retention_days: 365

Roadmap

• Daily rollups — an optional aggregate table for very high-traffic catalogs that want short raw retention while keeping long report history.

License

BSD-3-Clause. See LICENSE.

Credits

Built and maintained by Remy Vaartjes ([e-mail]) — part of the SilverShop-Suite.