Method
describeCustomMetric GET
Copy GET

Retrieves a full description of a previously registered custom metric function.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes name str Registered name of the custom metric.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result CustomMetric
KEY TYPE Description
customMetricId str Unique string identifier of the custom metric.
name str Name assigned to the custom metric.
createdAt str Date and time when the custom metric was created (ISO 8601 format).
problemType str Problem type that this custom metric is applicable to (e.g. regression).
notebookId str Unique string identifier of the notebook used to create/edit the custom metric.
latestCustomMetricVersion CustomMetricVersion Latest version of the custom metric.

Exceptions:

TYPE WHEN
InvalidParameterError

If the custom metric name is invalid.
DataNotFoundError

If a custom metric with the given name is not found in the organization.
Language:

Coming Soon!

© Copyright 2025