Metrics Platform

The Metrics Platform (MP) is a suite of tools that helps Wikimedia teams make data-driven decisions about product experiences. You can use the Metrics Platform to create instrumentation that captures click rates, conversion rates, and other metrics. Get started by choosing a workflow below.
type=fulltext
prefix=Metrics Platform/
width=40
placeholder=Search Metrics Platform docs 
searchbuttonlabel=Search
break=no
== Workflows ==
* Conduct an experiment
* Measure product health
== Guides ==
* Create an instrument
* Local development setup
* Decommission an instrument
== Templates ==
* Measurement plan
* Instrumentation spec
* Experimentation scorecard
== API docs ==
* JavaScript
* PHP
* Java
* Swift
== Reference ==
* App schema
* Web schema
* Custom schemas
* Contextual attributes
* Interaction data
* Stream configuration
* Analytics sampling
* Feature Availability
== Meta == 
* List of active instruments
* Glossary
* FAQ
* About
== Metrics Platform maintainer documentation ==
* Maintainer introduction
* Architecture
* Deploy client libraries
* Validate events
* MPIC administration
* Custom Data Monitor
* Documentation maintenance
=== Decision records ===
== Support ==
If you have questions that are not covered by these pages, or additional guidance is needed, please don't hesitate to reach out using the Data Products intake process.
== Contributing ==
Contributions to the Metrics Platform client libraries are most welcome and appreciated. Learn more about contributing to Metrics Platform development
== About ==
Built on the Event Platform, the Metrics Platform provides standardized algorithms, behaviors, and basic necessities for web and app instrumentation, including:
* a specialized Event Platform client designed to require less work in creating instrumentation
* a predefined core interaction schema covering the most common data fields
* a library of event schemas designed for use across a wide range of projects 
* a library of already existing instruments to be reused directly or as a starting point
* easy means to build new schemas to further enrich events with contextual data
* the ability to mix in different schemas depending on your needs
* standardized session ID generation, consistent across MediaWiki, Android, and iOS
* standardized session expiry
* determining which events are in-sample or out-of-sample based on a specific identifier (currently: pageview, session, or app install ID).
To learn more about the Metrics Platform and which components are available to use, see the FAQ.
=== When to use Metrics Platform ===
Metrics Platform is a good fit for products within MediaWiki without pre-existing Event Platform instrumentation. Here are a few situations where the Event Platform would be a better option for creating instrumentation:
* Browser extensions, backend services outside of MediaWiki, or programming languages not covered by the Metrics Platform API
* Websites outside of MediaWiki (although these sites can still use the Metrics Platform schema conventions)
* Existing features instrumented using the Event Platform. In this case, it can be preferable to continue to use the Event Platform to keep everything consistent
=== Background ===
Previously, different teams implemented their own analytics solutions in isolation from one another. Those solutions were typically based on the Legacy EventLogging pipeline and, more recently, the Event Platform. The Metrics Platform is an effort to unify that previous work and to establish uniformity and consistency across platforms. Its objectives include:
* making it easier to implement and maintain instruments. The Metrics Platform will provide the APIs and protocols that MediaWiki developers need to create sophisticated instruments in as few lines of code as possible while maintaining quality, rigor, and safety.
* making it easier for analysts to support teams which are not their primary teams. Previously, every instrument has its own quirks and conventions, which need to be remembered by analyst that works with the data produced by the instrument – including analysts that are providing temporary support.
* making it easier to leverage data from multiple platforms to yield insights into how our users use our whole ecosystem of products in unison.
== All pages ==