Skip to main content
PUT
PUT /v1/tables/{id}/customMetric

Custom Metrics

Define custom SQL-based metrics on a table or specific column. Custom metrics are evaluated during profiling runs and tracked over time.

Add Custom Metric

PUT /v1/tables/{id}/customMetric
string
required
UUID of the table.
string
required
Name of the custom metric. Must be unique within the table.
string
required
SQL expression to evaluate for this metric. Must return a single numeric value.
string
Name of the column this metric applies to. If omitted, the metric is table-level.
string
Description of what this metric measures.

Delete Custom Metric

DELETE /v1/tables/{id}/customMetric/{metricName}
string
required
UUID of the table.
string
required
Name of the custom metric to delete.
PUT /v1/tables/{id}/customMetric

Returns

Add returns the updated table object with the custom metric included. Delete returns no content (204).

Response

array
Array of custom metrics defined on the table.

Error Handling