Metrics

Get a Metric by fully qualified name.

Get a Metric by fully qualified name.

get/v1/metrics/name/{fqn}

Request

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

Path parameters

fqnstring required

Fully qualified name of the Metric

Query parameters

fieldsstring
Example:owners,reviewers,relatedMetrics,followers,tags,extension,domains,dataProducts

Fields requested in the returned resource

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

includeRelationsstring
Example:owners:non-deleted,followers:all

Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value.

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.