Add analytics for usage of the API documentation

Repository metrics

Stars

477 stars (477 stars)

PR merge metrics

Avg merge 15d 21h (Avg merge 15d 21h)157 merged PRs in 30d (157 merged PRs in 30d)

Description

<!-- Matomo -->
<script>
  var _paq = window._paq = window._paq || [];
  /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
  _paq.push(['trackPageView']);
  _paq.push(['enableLinkTracking']);
  (function() {
    var u="https://analytics.openfoodfacts.org/";
    _paq.push(['setTrackerUrl', u+'matomo.php']);
    _paq.push(['setSiteId', '16']);
    var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
    g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
  })();
</script>
<!-- End Matomo Code -->

Contributor guide

Research direction

Locate the main mkdocs configuration file (likely mkdocs.yml) in the repository. Review the MKDocs Material documentation on custom site analytics (linked in the issue). Add the provided Matomo script to the custom JavaScript section via the `extra javascript` configuration or directly into the HTML template. Ensure the script is included on all API documentation pages. Test locally to verify the analytics tracker loads correctly.

Tech stack

htmljavascript

Domain

documentationanalytics

Issue type

Feature

DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.

2

Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.

1-3 hours

Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.

Stale

ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.

Mostly clear

Prerequisites

Knowledge of MKDocs MaterialAccess to repository documentation folder

Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.

60