Skip to main content
Preview The Metrics Studio catalog lists every metric in a workspace and shows, for each one, whether agents can read it. Use it before you change a metric, when you need to know which calculation an agent is using, or when you are looking for a metric that may already exist. It complements the /atlan-analytics skill, which builds and looks up metrics through the Gateway MCP.

Before you begin

Before you start, make sure you have:
  • Access: Access to Metrics Studio and a workspace that has metrics. An empty workspace shows “No metrics in yet” and a Start your metric layer panel instead.
  • Metric app: An administrator has installed the Metric app in your account.
1

Open catalog

In the sidebar, under Catalog, choose Metrics. A count badge beside it shows how many metrics are in scope.Each row has a Metric column (the name, then a line with its warehouse connector, Uses N, Used by N, and its description), a Release column, an Owner column (Unassigned when none is recorded), and Updated. If two metrics share a display name, Studio shows the identifier under each name so you can tell them apart.
2

Search and narrow list

Type in the search box, whose placeholder is Name or description. Studio shows whether results came “from the gateway” (ranked) or matched on text only. Then narrow the list:
  • Views: All, Unreleased changes (the live release is behind the newest revision), Not released, and Archived.
  • Filter: by Owner, by Warehouse, and by Replacement. The Replaced, still live option appears only when a live metric has a replacement.
  • Sort: Recently updated (the default), Name A–Z, and Relevance (only after a ranked search).
The footer reads “N of M shown”, with the number of active filters. Clear search and filters resets the list.
3

Read release state

The Release column says what agents get today:
4

Open metric

Choose the metric’s name. Its page has these tabs:
  • Overview: a plain-words summary. What it measures lists what it includes and excludes, its granularity, unit, and parameters. How it’s calculated shows the source table, joins, conditions, and aggregation as connected steps. Joins and dimensions appears when the metric declares dimensions. Examples shows the first four questions, with View all N examples for the rest.
  • Definition: the metric’s parts, such as formula, source, dimensions, joins, parameters, and calculation settings.
  • Examples: each question with its SQL, and a May be out of date chip when its saved sample predates a change to the calculation.
  • Dependencies: what the metric uses and what uses it. A Changed badge means a dependency changed after the live version was released.
  • History: every saved revision. Every save creates a revision, and releasing a revision gives it a version number. Release tags are Live, Released, Earlier, Pending, and Withdrawn. Earlier is a superseded version that is kept and still viewable.
If the revision you are reading is not the live one, a banner says “You are reading revision , which is not released. Agents get .” Choose See what agents get to open the live version.
5

Verify what agents get

In History, open the version tagged Live. Its page, Version , shows exactly what agents get now, and it does not change when newer revisions are saved until another version is released. It shows the formula, What it measures in this version, and This version as JSON. Download release snapshot saves the version as {release_id}.json.
A version page shows the stored definition. It does not show that the SQL runs or that the number is right, because Studio never executes SQL.
If the catalog shows “The catalog could not be read. Nothing below is a complete list.”, the list is incomplete. Reload the page before you rely on it.

Next steps

See also