Background
Coming out of a recent spike T345439 (Prototype API for Submitting Core Interaction Events), we have an initial proposal for an API that specifies some preliminary methods for submitting events against the newly drafted, to-be-merged core interactions schemas (See T345439#9217684).
Developer notes
Presumably this goal entails documenting the proposed API and detailing the process by which a given instrument managed by a feature team can use the Metrics Platform (MP) starting from:
- schema creation (if applicable) by referencing the core interactions schemas
- implementing the relevant API methods for their use cases in client code
- adding new stream configs for the respective instrument (if a new custom concrete schema is being introduced)
- verifying that events sent via MP are being submitted successfully and passing validation
We should also document MP-owned schemas so that feature teams can easily reference them in their own custom schemas or use them directly.
Requirements
- Documentation of new additions based on data contract API on wikitech
- Document learnings/findings from Product Analyst review of schema proposal T345729: [REQUEST] Review of new Metrics Platform Event types in relation to existing schemas
- Architect solution for core interactions T345439: [SPIKE] Prototype API for Submitting Core Interaction Events
- Architect solution for funnel journeys T346316: [SPIKE] How can we persist and/or transmit funnel state between boundaries?
- Refactor client libraries