Private Metrics

There are likely certain metrics in your organization that should only be visible to particular individuals or teams. Private metrics give metric owners the ability to manage the visibility permissions of metrics for users in your organization. As a metric owner, you have the control to determine who has access to view a metric's data in Transform.

Making a Metric Private

1. Navigate to a metric page.
2. Click the metric settings icon and go to the Privacy tab.
3. The default state for metrics defined in Transform is public visibility to everyone in your organization. If you'd like to make this metric private, click the "Make Private" radio button. Otherwise, leave as "Keep Public".
4. Use the search box to search for individuals or teams and click the "Allow Access" button next to their name if you'd like to give them viewer access to this metric. Once you've added users via the search box, you can double check who you've added in the "Viewer Names" list.
5. Click "Save" and now the metric is private and only visible to the individuals and teams in the "Viewer Names" list. You can remove/allow access at anytime via this Privacy tab.

Making a metric private in YAML configuration file

Technical owners of the metric can set a metric as private in the locked metadata section of the metric YAML configuration file.

See the example below on how to set this option. If you don't want the metric to be private, you can simply omit this option.

  metric:
    name: revenue_mtd
    description: revenue mtd
    owners:
      - support@transformdata.io
    type: cumulative
    locked_metadata:
      value_format: "$$,.2f"
      private: true

note

You cannot change the privacy status (e.g. private or public) in the Transform App if a technical owner has set the privacy option in the locked metadata of the YAML configuration file.

Making a metric private during metric setup

As a technical owner, when you are setting up a metric for the first time in Transform, you'll see that you're required to set the privacy of the metric in the metric setup flow. First, fill out the information in the Metadata tab. Then, click "Save & Continue" to go to the Privacy tab. Then, you can follow the same steps 3-5 mentioned above.

note

All metric owners (business owners and technical owners) and org admins have access to this metric regardless of privacy status. Metric owners and org admin names will not show up in the "Viewer Names" list.

Private Metrics Affected Areas

Once a metric is made private, its privacy setting will propogate and affect the following areas in Transform for users who do not have access to view the metric:

Affected Area	Behavior
Metric page (individual metric)	Only metric name, metric tier, and metric owners are visible. There's a button to request access to view the metric.
Homepage - Annotations	Annotations for a private metric are hidden from this list.
Homepage - Metrics You May Care About	Private metrics are hidden from this list.
Homepage - Subscription cards	Only metric name and metric tier are visible. Clicking on the search result will take you to a locked metric page where you can request access.
Global search bar	Only metric name and metric tier are visible. Clicking on the search result will take you to a locked metric page where you can request access.
Metrics page (all metrics)	Only metric name, metric tier, and metric owners are visible if the metric is private. There's a button to request access to view the metric.
Boards page	Only metric name and filters are visible on private metric charts. There's a button to request access to view the metric. This behavior also applied to saved query charts that use a private metric.
Query page	Only metric name and filters are visible on saved query charts that use a private metric. There's a button to request access to view the metric. Once you receive access to the underlying private metric, then you will be able to interact with the saved query.
Model page	Metric details are locked for private metrics.
CLI	The CLI returns an error message explaining that you cannot view the results for that query because you don't have access to the private metric. If you are querying multiple metrics, the CLI returns an error message explaining which private metrics you don't have access to.
MQL Query Logs	For MQL queries that include a private metric, the "Results" tab in query details is hidden.

Private Metrics and Downstream Integrations

Google Sheets

If you try to query a private metric you don't have access to, an error message is displayed explaining that you cannot view the results for that query because you don't have access to the private metric.

Excel

If you try to query a private metric you don't have access to, an error message is displayed explaining that you cannot view the results for that query because you don't have access to the private metric.

Tableau

If you try to query a private metric you don't have access to, an error message is displayed explaining that you cannot view the results for that query because you don't have access to the private metric.

Hex

Transform's JDBC driver currently does not support private metrics. Since our Hex integration is built on top of the JDBC driver, private metrics will be visible in this tool.

Mode

Transform's JDBC driver currently does not support private metrics. Since our Mode integration is built on top of the JDBC driver, private metrics will be visible in this tool.