Skip to main content
You are reading the docs of Galtea 5.19. Read this page in the latest version.

Returns

Returns a Metric object for the given metric name.

Example

Parameters

string
required
The name of the metric you want to retrieve.

How a name is resolved

The platform looks for the name in two steps:
  1. A metric whose name it is. The call returns that metric’s active revision.
  2. Only when no metric you can see holds the name: an active revision saved under that name as its own.
A revision can keep its own name after its metric is renamed. In that case the returned name is the revision’s own name, so it can differ from the name you asked for. Do not compare the returned name with the name you passed.
Names can change. When you have a metric’s ID, call galtea.metrics.get instead.

Errors