Introduction: API Reference - Matomo Analytics (formerly Piwik Analytics) - Developer Docs

<!DOCTYPE html> <html lang="en"> <head> <title>Introduction: API Reference - Matomo Analytics (formerly Piwik Analytics) - Developer Docs - v5</title> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <link href="/css/bootstrap.min.css?943e7eff" rel="stylesheet"> <link href="/css/font-awesome.min.css?943e7eff" rel="stylesheet"> <link href="/css/highlight.obsidian.css?943e7eff" rel="stylesheet" media="screen"> <link href="/css/app.css?943e7eff" rel="stylesheet" media="screen"> <link href="/css/sidebar.css?943e7eff" rel="stylesheet" media="screen"> <link href="/css/documentation.css?943e7eff" rel="stylesheet" media="screen">  <link rel="icon" type="image/png" href="/favicon.png"> </head> <body> <div id="menu" class="navbar navbar-inverse navbar-fixed-top"> <div class="container"> <div class="navbar-header"> <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="navbar-brand hidden-sm" href="/"><img height="20" width="124" src="/img/logo.png"/></a> </div> <div class="collapse navbar-collapse"> <ul class="nav navbar-nav"> <li > <a href="/integration">Integrate</a> </li> <li > <a href="/develop">Develop</a> </li> <li class="active"> <a href="/api-reference">API Reference</a> </li> <li > <a href="/piwik-in-depth">In Depth</a> </li> <li > <a href="/changelog">Changelog</a> </li> <li > <a href="/support">Support</a> </li> </ul> <ul class="nav navbar-nav pull-right"> <li> <div id="quick-search-typeahead"> <input type="text" data-action="/data/documents" placeholder="Quick search..."/> <select title="Select your Matomo version" class="piwik-version-select" name="piwik"> <option value="/4.x/api-reference" >Matomo 4.X</option> <option value="/api-reference" selected >Matomo 5.X</option> </select> </div> </li> </ul> </div> </div> </div> <div class="container"> <div class="row"> <div class="col-sm-4 col-md-3"> <div class="bs-side panel-group"> <div class="panel panel-primary"> <div class="panel-heading"> <h4 class="panel-title"> <a href="/api-reference"> API Reference </a> </h4> </div> <div class="panel-body bs-sidebar"> <ul class="nav nav-pills nav-stacked bs-sidenav"> <li class="active" title="Introduction"> <a href="/api-reference/api-reference-introduction">Introduction</a> <ul class="nav"> </ul> </li> <li class="" title="Tracking"> <span>Tracking</span> <ul class="nav"> <li class="" title="Tracking HTTP API"> <a href="/api-reference/tracking-api"> Tracking HTTP API</a> </li> <li class="" title="JavaScript Tracking Client"> <a href="/api-reference/tracking-javascript"> JavaScript Tracking Client</a> </li> <li class="" title="Java Tracker"> <a href="/api-reference/tracking-java"> Java Tracker</a> </li> <li class="" title="MatomoTracker"> <a href="/api-reference/PHP-Matomo-Tracker"> PHP Tracking Client</a> </li> </ul> </li> <li class="" title="Tag Manager"> <span>Tag Manager</span> <ul class="nav"> <li class="" title="Tag Manager JavaScript API"> <a href="/api-reference/tagmanager/javascript-api-reference"> Tag Manager JavaScript API</a> </li> </ul> </li> <li class="" title="Reporting HTTP API"> <span>Reporting HTTP API</span> <ul class="nav"> <li class="" title="Reporting API Reference"> <a href="/api-reference/reporting-api"> Reporting API Reference</a> </li> <li class="" title="Metadata"> <a href="/api-reference/reporting-api-metadata"> Metadata</a> </li> <li class="" title="Segmentation"> <a href="/api-reference/reporting-api-segmentation"> Segmentation</a> </li> </ul> </li> <li class="" title="PHP Plugins API"> <span>PHP Plugins API</span> <ul class="nav"> <li class="" title="Classes"> <a href="/api-reference/classes"> Classes</a> </li> <li class="" title="Events"> <a href="/api-reference/events"> Events</a> </li> <li class="" title="Index"> <a href="/api-reference/index"> Index</a> </li> </ul> </li> <li class="" title="WordPress"> <span>WordPress</span> <ul class="nav"> <li class="" title="Classes"> <a href="/api-reference/wordpress/classes-reference"> Classes</a> </li> <li class="" title="Hooks"> <a href="/api-reference/wordpress/hooks-reference"> Hooks</a> </li> <li class="" title="REST API"> <a href="/api-reference/wordpress/restapi-reference"> REST API</a> </li> </ul> </li> <li class="" title="Database"> <span>Database</span> <ul class="nav"> <li class="" title="Database schema"> <a href="/guides/database-schema"> Database schema</a> </li> </ul> </li> </ul> </div> </div> </div> </div> <div class="col-sm-8 col-md-9 documentation"> <h1 id="api-reference">API Reference</h1> <p>The API Reference contains low-level details on Matomo (formerly Piwik) APIs and codebase.</p> <p>You will find here documentation on Matomo's HTTP APIs, JavaScript client, PHP and Java classes, methods and hooks.</p> </div> </div> </div> <footer> <div class="container"> <p class="pull-left"> Copyright © <a href="https://matomo.org">Matomo.org</a> | <a href="https://twitter.com/matomo_org"><i class="fa fa-twitter"></i> Twitter</a> | <a href="https://github.com/matomo-org"><i class="fa fa-github"></i> GitHub</a> </p> <p class="pull-right"> <a href="https://github.com/matomo-org/developer-documentation/tree/live/docs/5.x/api-reference-introduction.md" target="_blank">Edit on GitHub</a> </p> <p class="pull-right"> <a href="mailto:developer@matomo.org?subject=Feedback%20Developer%20Guides">Give Feedback</a> |  </p> <p class="pull-right"> <a href="https://matomo.org/privacy-policy" target="_blank">Privacy Policy</a> |  </p> </div> </footer> <script src="/js/jquery.js?943e7eff"></script> <script src="/js/bootstrap.min.js?943e7eff"></script> <script src="/js/bootstrap3-typeahead.min.js?943e7eff"></script> <script src="/js/app.js?943e7eff"></script> <script src="/js/highlight.8.2.min.js?943e7eff"></script> <script type="text/javascript"> $(document).ready(function () { // Disable language auto-detect on code blocks that don't have a language // This prevents a messy highlighting when the block doesn't contain code $('pre code:not([class])').addClass('no-highlight hljs'); hljs.initHighlightingOnLoad(); }); </script>  <script type="text/javascript"> var _paq = _paq || []; _paq.push(["disableCookies"]); _paq.push(["setCustomVariable", 1, 'PiwikVersion', '5', 'page']); _paq.push(["trackPageView"]); _paq.push(["enableLinkTracking"]); function track() { (function() { var u="https://demo.matomo.org/"; _paq.push(["setTrackerUrl", u+"piwik.php"]); _paq.push(["setSiteId", "36"]); var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0]; g.type="text/javascript"; g.defer=true; g.async=true; g.src=u+"piwik.js"; s.parentNode.insertBefore(g,s); })(); } if (window.addEventListener) { window.addEventListener("load", track, false); } else if (window.attachEvent) { window.attachEvent("onload",track); } else { track(); } </script>  </body> </html>

CINXE.COM

Introduction: API Reference - Matomo Analytics (formerly Piwik Analytics) - Developer Docs - v5