Metrics

Create or update a metric

Create a new metric, if it does not exist or update an existing metric.

put/v1/metrics

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/metrics
  • Auth: HTTP bearer

Request body

namestring required
displayNamestring
descriptionstring
metricType'COUNT' | 'SUM' | 'AVERAGE' | 'RATIO' | 'PERCENTAGE' | 'MIN' | 'MAX' | 'MEDIAN' | 'MODE' | 'STANDARD_DEVIATION' | 'VARIANCE' | 'SIMPLE' | 'CUMULATIVE' | 'DERIVED' | 'CONVERSION' | 'OTHER'
unitOfMeasurement'COUNT' | 'DOLLARS' | 'PERCENTAGE' | 'TIMESTAMP' | 'SIZE' | 'REQUESTS' | 'EVENTS' | 'TRANSACTIONS' | 'OTHER'
customUnitOfMeasurementstring
granularity'SECOND' | 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR'
relatedMetricsstring[]
domainsstring[]
dataProductsstring[]
extensionobject
provider'system' | 'user' | 'automation'

Response

The metric

idstring uuid required
namestring required
fullyQualifiedNamestring
displayNamestring
descriptionstring
metricType'COUNT' | 'SUM' | 'AVERAGE' | 'RATIO' | 'PERCENTAGE' | 'MIN' | 'MAX' | 'MEDIAN' | 'MODE' | 'STANDARD_DEVIATION' | 'VARIANCE' | 'SIMPLE' | 'CUMULATIVE' | 'DERIVED' | 'CONVERSION' | 'OTHER'
unitOfMeasurement'COUNT' | 'DOLLARS' | 'PERCENTAGE' | 'TIMESTAMP' | 'SIZE' | 'REQUESTS' | 'EVENTS' | 'TRANSACTIONS' | 'OTHER'
customUnitOfMeasurementstring
granularity'SECOND' | 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR'
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
hrefstring uri
deletedboolean
extensionobject
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
provider'system' | 'user' | 'automation'
sourceHashstring

Changes

No recorded changes to this operation across all 1 revision of this API.