Skip to content

acol248/strapi-analytics

Repository files navigation

Strapi Analytics

A standalone anonymous analytics plugin for Strapi CMS.

Dashboard screenshot

Getting Started

Note: This plugin is currently in active development and offers a minimal feature set. Expect frequent updates and potential breaking changes as it matures.

Installing Plugin

Run the following command

npm install strapi-analytics

...and paste the following into your plugins.ts file.

...
"strapi-analytics": {
  enabled: true,
},
...

Adding the tracking script to your website

Paste the following snippet into the of your website's HTML layout. This script initializes the global sana tracker asynchronously, meaning it won't impact your site's loading performance.

<!-- Strapi Analytics Plugin -->
<script>
  (function (w, d, s, o, g, r, a, m) {
    w['StrapiAnalyticsObject'] = g;
    ((w[g] =
      w[g] ||
      function () {
        (w[g].q = w[g].q || []).push(arguments);
      }),
      (w[g].l = 1 * new Date()));
    ((a = d.createElement(s)), (m = d.getElementsByTagName(s)[0]));
    a.async = 1;
    a.src = o;
    m.parentNode.insertBefore(a, m);
  })(
    window,
    document,
    'script',
    'https://your-strapi-domain.com/api/strapi-analytics/tracker.js',
    'sana'
  );

  sana('init', 'S-XXXXXXXXXXX'); // replace this with a code generated in your CMS
  sana('pageview');
</script>
<!-- End Strapi Analytics Plugin -->

Tracking functions

Page View

Tracks a standard Page View action (page_view) inside the collection.

sana('pageview', { customMetadataKey: 'value' });

Standard Page View tracks can be also include Strapi

sana(
  'pageview',
  { customMetadataKey: 'value' },
  { uid: 'api::example.example', documentId: 't0nlv95xugj9f9kl8qcu5grz' }
);

Custom actions

Send custom events (e.g., standard action types configured in the schema like click, file_download, form_submit, search, scroll, or custom).

sana('track', 'click', { buttonId: 'signup' });

Granular Content & Document Validation

Link specific actions directly to models and existing documents in your database. The API automatically validates that both the model and the specified document exist. This prevents data injection errors and enforces schema integrity.

sana(
  'track',
  'click',
  { campaign: 'summer_sale_2026' }, // Custom metadata
  { uid: 'api::product.product', documentId: 'prod_abc123xyz' } // Strapi Content-Type Details
);

Supported actions

  • page_view
  • click
  • file_download
  • form_submit
  • search
  • scroll
  • custom

Roadmap

  • Add a token/key requirement to track endpoint that prevents unauthorized access.
  • Create copy/paste script that can be added to users websites allowing easy interaction with analytics tracking.
  • Add content type specific dashboards.
  • Make dashboards customisable
  • Save dashboard layouts against the user in the database.
  • Ensure RBAC is setup and used appropriately.
  • Add drilled down layers that allow for granular tracking - track the CT, the documentId, how data in the document is interacted with.
  • Make the graphs and associated functions more generalised where necessary (in progress)
  • Add more graph types to dashboards.
  • Add better time scale adjustments to dashboards.
  • Add export features.
  • npm installation method.
  • Redesign current card types
  • Make the items that can be added to dashboards work as widgets for use on Strapi homepage

Please feel free to suggest further features for the roadmap.

About

Strapi analytics plugin for lightweight, self-hosted event tracking and native database document validation.

Topics

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Contributors