MetaRouter's UI is built to empower your organization with the ability to control data sent to your vendors and provide parameter-by-parameter instructions for adding to, dropping, or transforming event payloads after they are ingested into the MetaRouter platform, but before reaching your vendors.
Before you dive into the UI, there are a few key concepts you need to understand:
A Cluster represents the hardware that the MetaRouter platform is installed upon- specifically, the servers within a region your Cloud Provider offers. The MetaRouter Platform can be installed within multiple Clusters to provide better resiliency and speed for data collection, which we can provide guidance for based on your requirements.
Because the MetaRouter platform is designed to be a single-tenant, private data infrastructure, a cluster is built independent of the UI but can easily be connected to the UI so you can deploy your integrations and pipelines, which we discuss below.
A pipeline represents data originating from a single source and a set of integrations that should receive data from that source. Pipelines are designated by a unique writeKey and should be deployed within your cluster, as well as specified within the UI.
A Pipeline could contain your website's production data, or your iOS app's staging environment. Typically these are designated by:
- The source of the data- web, iOS/Android app, or server.
- Environment- dev, staging, production, etc.
An Integration consumes data from a pipeline and forwards that data to its specific destination (whether it's Facebook, your data warehouse, an analytics tool, etc.). Each integration can be configured with specific transformations that allow for fine grain control of your data inside the MetaRouter platform.
When you set up an Integration for the first time, you must let us know. We will install a service inside of your Cluster that will handle the actual forwarding of an event to your integration. For example, if you set up the MetaRouter platform, and after the fact your marketing team wishes to replace Facebook's pixel with a MetaRouter integration, you would need to let us know. However, if Facebook already exists on a cluster and you wish to set up a new Facebook integration on that same cluster, you would not necessarily need to let us know.
Integrations in the UI contain parameter-by-parameter instructions for how to handle events sent to a specific vendor, and gives you the option to:
- Send and transform a parameter for all events with Global Configs. These are typically API keys, Secrets, Account IDs, and other credentials required for a vendor to accept an event.
- Send and transform a parameter for a specific event we see with Event Configs. These are parameters included for specific events such as those generated through page, call, identify, and other event types.
- Designate how to handle parameters sent to MetaRouter but not specified by Global Configs or Event Configs. This represents a catch-all, where you can either instruct us to pass any additional parameters we receive to your vendor, drop unspecified parameters, and/or transform parameters according to general instructions you set.
When setting up integrations, there are additional definitions you should be aware of to help you apply your desired event transforms. You can find those definitions here.
Once you have reviewed the above definitions, head over to our Quick Start Guide to get started.
Updated about 2 months ago