`Metrics` are measurements computed from data such as `Monthly Active Users`. Some of the metrics that measures used to determine performance against an objective are called KPIs or Key Performance Indicators, such as `User Retention`.
openapi: 3.0.1
info:
title: OpenMetadata APIs Agent Executions Metrics API
description: Common types and API definition for OpenMetadata
contact:
name: OpenMetadata
url: https://open-metadata.org
email: openmetadata-dev@googlegroups.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '1.13'
servers:
- url: /api
description: Current Host
- url: http://localhost:8585/api
description: Endpoint URL
security:
- BearerAuth: []
tags:
- name: Metrics
description: '`Metrics` are measurements computed from data such as `Monthly Active Users`. Some of the metrics that measures used to determine performance against an objective are called KPIs or Key Performance Indicators, such as `User Retention`.'
paths:
/v1/metrics/{id}/followers:
put:
tags:
- Metrics
summary: Add a follower
description: Add a user identified by `userId` as followed of this Metric.
operationId: addFollower_7
parameters:
- name: id
in: path
description: Id of the Metric
required: true
schema:
type: string
format: uuid
requestBody:
description: Id of the user to be added as follower
content:
application/json:
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEvent'
'404':
description: APIEndpoint for instance {id} is not found
/v1/metrics/bulk:
put:
tags:
- Metrics
summary: Bulk create or update metrics
description: Create or update multiple metrics in a single operation.
operationId: bulkCreateOrUpdateMetrics
parameters:
- name: async
in: query
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMetric'
responses:
'200':
description: Bulk operation results
'202':
description: Bulk operation accepted for async processing
'400':
description: Bad request
/v1/metrics:
get:
tags:
- Metrics
summary: List metrics
description: Get a list of metrics. Use `fields` parameter to get only necessary fields.
operationId: listMetrics
parameters:
- name: fields
in: query
description: Fields requested in the returned resource
schema:
type: string
example: owners,reviewers,relatedMetrics,followers,tags,extension,domains,dataProducts
- name: limit
in: query
schema:
maximum: 1000000
minimum: 0
type: integer
format: int32
default: 10
- name: before
in: query
description: Returns list of metrics before this cursor
schema:
type: string
- name: after
in: query
description: Returns list of metrics after this cursor
schema:
type: string
- name: include
in: query
description: Include all, deleted, or non-deleted entities.
schema:
type: string
default: non-deleted
enum:
- all
- deleted
- non-deleted
responses:
'200':
description: List of metrics
content:
application/json:
schema:
$ref: '#/components/schemas/MetricsList'
put:
tags:
- Metrics
summary: Create or update a metric
description: Create a new metric, if it does not exist or update an existing metric.
operationId: createOrUpdateMetric
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMetric'
responses:
'200':
description: The metric
content:
application/json:
schema:
$ref: '#/components/schemas/Metric'
'400':
description: Bad request
post:
tags:
- Metrics
summary: Create a Metric
description: Create a Metric.
operationId: createMetric
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMetric'
responses:
'200':
description: The Metric
content:
application/json:
schema:
$ref: '#/components/schemas/Metric'
'400':
description: Bad request
/v1/metrics/name/{fqn}:
get:
tags:
- Metrics
summary: Get a Metric by fully qualified name.
description: Get a Metric by fully qualified name.
operationId: getMetricByFQN
parameters:
- name: fqn
in: path
description: Fully qualified name of the Metric
required: true
schema:
type: string
- name: fields
in: query
description: Fields requested in the returned resource
schema:
type: string
example: owners,reviewers,relatedMetrics,followers,tags,extension,domains,dataProducts
- name: include
in: query
description: Include all, deleted, or non-deleted entities.
schema:
type: string
default: non-deleted
enum:
- all
- deleted
- non-deleted
- name: includeRelations
in: query
description: '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.'
schema:
type: string
example: owners:non-deleted,followers:all
responses:
'200':
description: The Metric
content:
application/json:
schema:
$ref: '#/components/schemas/Metric'
'404':
description: Metric for instance {fqn} is not found
delete:
tags:
- Metrics
summary: Delete a Metric by fully qualified name
description: Delete a Metric by `fullyQualifiedName`.
operationId: deleteAPIEndpointByFQN_1
parameters:
- name: hardDelete
in: query
description: Hard delete the entity. (Default = `false`)
schema:
type: boolean
default: false
- name: fqn
in: path
description: Fully qualified name of the Metric
required: true
schema:
type: string
responses:
'200':
description: OK
'404':
description: Metric for instance {fqn} is not found
patch:
tags:
- Metrics
summary: Update a Metric using name.
description: Update an existing Metric using JsonPatch.
externalDocs:
description: JsonPatch RFC
url: https://tools.ietf.org/html/rfc6902
operationId: patchMetric
parameters:
- name: fqn
in: path
description: Name of the Metric
required: true
schema:
type: string
requestBody:
description: JsonPatch with array of operations
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/JsonPatch'
example: '[{op:remove, path:/a},{op:add, path: /b, value: val}]'
responses:
default:
description: default response
content:
application/json: {}
/v1/metrics/{id}:
get:
tags:
- Metrics
summary: Get a metric by Id
description: Get a metric by `Id`.
operationId: getMetricByID
parameters:
- name: id
in: path
description: Id of the metric
required: true
schema:
type: string
format: uuid
- name: fields
in: query
description: Fields requested in the returned resource
schema:
type: string
example: owners,reviewers,relatedMetrics,followers,tags,extension,domains,dataProducts
- name: include
in: query
description: Include all, deleted, or non-deleted entities.
schema:
type: string
default: non-deleted
enum:
- all
- deleted
- non-deleted
- name: includeRelations
in: query
description: '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.'
schema:
type: string
example: owners:non-deleted,followers:all
responses:
'200':
description: The metrics
content:
application/json:
schema:
$ref: '#/components/schemas/Metric'
'404':
description: Metrics for instance {id} is not found
delete:
tags:
- Metrics
summary: Delete a Metric by id
description: Delete a Metric by `id`.
operationId: deleteMetric
parameters:
- name: hardDelete
in: query
description: Hard delete the entity. (Default = `false`)
schema:
type: boolean
default: false
- name: id
in: path
description: Id of the Metric
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
'404':
description: Metric for instance {id} is not found
patch:
tags:
- Metrics
summary: Update a Metric
description: Update an existing Metric using JsonPatch.
externalDocs:
description: JsonPatch RFC
url: https://tools.ietf.org/html/rfc6902
operationId: patchMetric_1
parameters:
- name: id
in: path
description: Id of the Metric
required: true
schema:
type: string
format: uuid
requestBody:
description: JsonPatch with array of operations
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/JsonPatch'
example: '[{op:remove, path:/a},{op:add, path: /b, value: val}]'
responses:
default:
description: default response
content:
application/json: {}
/v1/metrics/async/{id}:
delete:
tags:
- Metrics
summary: Asynchronously delete a Metric by id
description: Asynchronously delete a Metric by `id`.
operationId: deleteMetricAsync
parameters:
- name: hardDelete
in: query
description: Hard delete the entity. (Default = `false`)
schema:
type: boolean
default: false
- name: id
in: path
description: Id of the Metric
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
'404':
description: Metric for instance {id} is not found
/v1/metrics/{id}/followers/{userId}:
delete:
tags:
- Metrics
summary: Remove a follower
description: Remove the user identified `userId` as a follower of the Metric.
operationId: deleteFollower_10
parameters:
- name: id
in: path
description: Id of the Metric
required: true
schema:
type: string
format: uuid
- name: userId
in: path
description: Id of the user being removed as follower
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEvent'
/v1/metrics/customUnits:
get:
tags:
- Metrics
summary: Get list of custom units of measurement
description: Get a list of all custom units of measurement that have been used in existing metrics. This helps UI provide autocomplete suggestions.
operationId: getCustomUnitsOfMeasurement
responses:
'200':
description: List of custom units
content:
application/json:
schema:
type: array
items:
type: string
/v1/metrics/{id}/versions/{version}:
get:
tags:
- Metrics
summary: Get a version of the Metric
description: Get a version of the Metric by given `id`
operationId: getSpecificEndpointVersion_1
parameters:
- name: id
in: path
description: Id of the Metric
required: true
schema:
type: string
format: uuid
- name: version
in: path
description: Metric version number in the form `major`.`minor`
required: true
schema:
type: string
example: 0.1 or 1.1
responses:
'200':
description: Metric Version
content:
application/json:
schema:
$ref: '#/components/schemas/Metric'
'404':
description: Metric for instance {id} and version {version} is not found
/v1/metrics/history:
get:
tags:
- Metrics
summary: List all entity versions within a time range
description: 'Get a paginated list of all entity versions within a given time range specified by `startTs` and `endTs` in milliseconds since epoch. '
operationId: listAllEntityVersionsByTimestamp_33
parameters:
- name: startTs
in: query
description: Start timestamp in milliseconds since epoch
required: true
schema:
type: integer
format: int64
- name: endTs
in: query
description: End timestamp in milliseconds since epoch
required: true
schema:
type: integer
format: int64
- name: limit
in: query
description: Limit the number of entity returned (1 to 1000000, default = 10)
schema:
maximum: 500
minimum: 1
type: integer
format: int32
default: 10
- name: before
in: query
description: Returns list of entity versions before this cursor
schema:
type: string
- name: after
in: query
description: Returns list of entity versions after this cursor
schema:
type: string
responses:
'200':
description: List of all versions
content:
application/json:
schema:
$ref: '#/components/schemas/ResultList'
/v1/metrics/{id}/versions:
get:
tags:
- Metrics
summary: List Metric versions
description: Get a list of all the versions of a metric identified by `id`
operationId: listAllMetricVersion
parameters:
- name: id
in: path
description: Id of the metric
required: true
schema:
type: string
format: uuid
responses:
'200':
description: List of Metric versions
content:
application/json:
schema:
$ref: '#/components/schemas/EntityHistory'
/v1/metrics/restore:
put:
tags:
- Metrics
summary: Restore a soft deleted Metric.
description: Restore a soft deleted Metric.
operationId: restore_24
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestoreEntity'
responses:
'200':
description: Successfully restored the Metric.
content:
application/json:
schema:
$ref: '#/components/schemas/Metric'
/v1/metrics/{id}/vote:
put:
tags:
- Metrics
summary: Update Vote for a Metric
description: Update vote for a Metric
operationId: updateVoteForMetric
parameters:
- name: id
in: path
description: Id of the Entity
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VoteRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEvent'
'404':
description: model for instance {id} is not found
components:
schemas:
TagLabelRecognizerMetadata:
required:
- recognizerId
- recognizerName
- score
type: object
properties:
recognizerId:
type: string
format: uuid
recognizerName:
type: string
score:
type: number
format: double
target:
type: string
enum:
- content
- column_name
patterns:
type: array
items:
$ref: '#/components/schemas/PatternMatch'
ChangeSummaryMap:
type: object
AccessDetails:
required:
- timestamp
type: object
properties:
timestamp:
type: integer
format: int64
accessedBy:
$ref: '#/components/schemas/EntityReference'
accessedByAProcess:
type: string
RestoreEntity:
required:
- id
type: object
properties:
id:
type: string
format: uuid
FieldChange:
type: object
properties:
name:
type: string
oldValue:
type: object
newValue:
type: object
CoverImage:
type: object
properties:
url:
type: string
position:
type: string
LifeCycle:
type: object
properties:
created:
$ref: '#/components/schemas/AccessDetails'
updated:
$ref: '#/components/schemas/AccessDetails'
accessed:
$ref: '#/components/schemas/AccessDetails'
MetricExpression:
type: object
properties:
language:
type: string
enum:
- SQL
- Java
- JavaScript
- Python
- External
code:
type: string
MetricsList:
required:
- data
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Metric'
paging:
$ref: '#/components/schemas/Paging'
errors:
type: array
items:
$ref: '#/components/schemas/EntityError'
warningsCount:
type: integer
format: int32
warnings:
type: array
items:
$ref: '#/components/schemas/EntityError'
EntityHistory:
required:
- entityType
- versions
type: object
properties:
entityType:
type: string
versions:
type: array
items:
type: object
AssetCertification:
required:
- appliedDate
- expiryDate
- tagLabel
type: object
properties:
tagLabel:
$ref: '#/components/schemas/TagLabel'
appliedDate:
type: integer
format: int64
expiryDate:
type: integer
format: int64
VoteRequest:
type: object
properties:
updatedVoteType:
type: string
enum:
- votedUp
- votedDown
- unVoted
ResultList:
required:
- data
type: object
properties:
data:
type: array
items:
type: object
paging:
$ref: '#/components/schemas/Paging'
errors:
type: array
items:
$ref: '#/components/schemas/EntityError'
warningsCount:
type: integer
format: int32
warnings:
type: array
items:
$ref: '#/components/schemas/EntityError'
Paging:
required:
- total
type: object
properties:
before:
type: string
after:
type: string
offset:
type: integer
format: int32
limit:
type: integer
format: int32
total:
type: integer
format: int32
JsonPatch:
type: object
ChangeDescription:
type: object
properties:
fieldsAdded:
type: array
items:
$ref: '#/components/schemas/FieldChange'
fieldsUpdated:
type: array
items:
$ref: '#/components/schemas/FieldChange'
fieldsDeleted:
type: array
items:
$ref: '#/components/schemas/FieldChange'
previousVersion:
type: number
format: double
changeSummary:
$ref: '#/components/schemas/ChangeSummaryMap'
ChangeEvent:
required:
- entityId
- entityType
- eventType
- id
- timestamp
type: object
properties:
id:
type: string
format: uuid
eventType:
type: string
enum:
- entityCreated
- entityUpdated
- entityFieldsChanged
- entityNoChange
- entitySoftDeleted
- entityDeleted
- entityRestored
- threadCreated
- threadUpdated
- postCreated
- postUpdated
- taskResolved
- taskClosed
- logicalTestCaseAdded
- suggestionCreated
- suggestionUpdated
- suggestionAccepted
- suggestionRejected
- suggestionDeleted
- userLogin
- userLogout
entityType:
type: string
entityId:
type: string
format: uuid
domains:
type: array
items:
type: string
format: uuid
entityFullyQualifiedName:
type: string
previousVersion:
type: number
format: double
currentVersion:
type: number
format: double
userName:
type: string
impersonatedBy:
type: string
timestamp:
type: integer
format: int64
changeDescription:
$ref: '#/components/schemas/ChangeDescription'
incrementalChangeDescription:
$ref: '#/components/schemas/ChangeDescription'
entity:
type: object
UsageStats:
required:
- count
type: object
properties:
count:
minimum: 0
exclusiveMinimum: false
type: integer
format: int32
percentileRank:
type: number
format: double
Style:
type: object
properties:
color:
type: string
iconURL:
type: string
coverImage:
$ref: '#/components/schemas/CoverImage'
Votes:
type: object
properties:
upVotes:
type: integer
format: int32
downVotes:
type: integer
format: int32
upVoters:
type: array
items:
$ref: '#/components/schemas/EntityReference'
downVoters:
type: array
items:
$ref: '#/components/schemas/EntityReference'
TagLabel:
required:
- labelType
- source
- state
- tagFQN
type: object
properties:
tagFQN:
type: string
name:
type: string
displayName:
type: string
description:
type: string
style:
$ref: '#/components/schemas/Style'
source:
type: string
enum:
- Classification
- Glossary
labelType:
type: string
enum:
- Manual
- Propagated
- Automated
- Derived
- Generated
state:
type: string
enum:
- Suggested
- Confirmed
href:
type: string
format: uri
reason:
type: string
appliedAt:
type: string
format: date-time
appliedBy:
type: string
metadata:
$ref: '#/components/schemas/TagLabelMetadata'
PatternMatch:
required:
- name
- score
type: object
properties:
name:
type: string
regex:
type: string
score:
type: number
format: double
Metric:
required:
- id
- name
type: object
properties:
id:
type: string
format: uuid
name:
maxLength: 256
minLength: 1
pattern: ^((?!::).)*$
type: string
fullyQualifiedName:
maxLength: 3072
minLength: 1
type: string
displayName:
type: string
description:
type: string
metricExpression:
$ref: '#/components/schemas/MetricExpression'
metricType:
type: string
enum:
- COUNT
- SUM
- AVERAGE
- RATIO
- PERCENTAGE
- MIN
- MAX
- MEDIAN
- MODE
- STANDARD_DEVIATION
- VARIANCE
- OTHER
unitOfMeasurement:
type: string
enum:
- COUNT
- DOLLARS
- PERCENTAGE
- TIMESTAMP
- SIZE
- REQUESTS
- EVENTS
- TRANSACTIONS
- OTHER
customUnitOfMeasurement:
type: string
granularity:
type: string
enum:
- SECOND
- MINUTE
- HOUR
- DAY
- WEEK
- MONTH
- QUARTER
- YEAR
relatedMetrics:
type: array
items:
$ref: '#/components/schemas/EntityReference'
version:
type: number
format: double
updatedAt:
type: integer
format: int64
updatedBy:
type: string
impersonatedBy:
type: string
href:
type: string
format: uri
owners:
type: array
items:
$ref: '#/components/schemas/EntityReference'
reviewers:
type: array
items:
$ref: '#/components/schemas/EntityReference'
followers:
type: array
items:
$ref: '#/components/schemas/EntityReference'
tags:
type: array
items:
$ref: '#/components/schemas/TagLabel'
changeDescription:
$ref: '#/components/schemas/ChangeDescription'
incrementalChangeDescription:
$ref: '#/components/schemas/ChangeDescription'
deleted:
type: boolean
domains:
type: array
items:
$ref: '#/components/schemas/EntityReference'
dataProducts:
type: array
items:
$ref: '#/components/schemas/EntityReference'
dataContract:
$ref: '#/components/schemas/EntityReference'
votes:
$ref: '#/components/schemas/Votes'
extension:
type: object
certification:
$ref: '#/components/schemas/AssetCertification'
entityStatus:
type: string
enum:
- Draft
- In Review
- Approved
- Archived
- Deprecated
- Rejected
- Unprocessed
provider:
type: string
enum:
- system
- user
- automation
children:
type: array
items:
$ref: '#/components/schemas/EntityReference'
service:
$ref: '#/components/schemas/EntityReference'
style:
$ref: '#/components/schemas/Style'
experts:
type: array
items:
$ref: '#/components/schemas/EntityReference'
usageSummary:
$ref: '#/components/schemas/UsageDetails'
lifeCycle:
$ref: '#/components/schemas/LifeCycle'
TagLabelMetadata:
type: object
properties:
recognizer:
$ref: '#/components/schemas/TagLabelRecognizerMetadata'
expiryDate:
type: integer
format: int64
EntityError:
type: object
properties:
message:
type: string
entity:
type: object
CreateMetric:
required:
- name
type: object
properties:
name:
maxLength: 256
minLength: 1
pattern: ^((?!::).)*$
type: string
displayName:
type: string
description:
type: string
metricExpression:
$ref: '#/components/schemas/MetricExpression'
metricType:
type: string
enum:
- COUNT
- SUM
- AVERAGE
- RATIO
- PERCENTAGE
- MIN
- MAX
- MEDIAN
- MODE
- STANDARD_DEVIATION
- VARIANCE
- OTHER
unitOfMeasurement:
type: string
enum:
- COUNT
- DOLLARS
- PERCENTAGE
- TIMESTAMP
- SIZE
- REQUESTS
- EVENTS
- TRANSACTIONS
- OTHER
customUnitOfMeasurement:
type: string
granularity:
type: string
enum:
- SECOND
- MINUTE
- HOUR
- DAY
- WEEK
- MONTH
- QUARTER
- YEAR
relatedMetrics:
type: array
items:
type: string
owners:
type: array
items:
$ref: '#/components/schemas/EntityReference'
reviewers:
type: array
items:
$ref: '#/components/schemas/EntityReference'
tags:
type: array
items:
$ref: '#/components/schemas/TagLabel'
domains:
type: array
items:
type: string
dataProducts:
type: array
items:
type: string
extension:
type: object
lifeCycle:
$ref: '#/components/schemas/LifeCycle'
EntityReference:
required:
- id
- type
type: object
properties:
id:
type: string
format: uuid
type:
type: string
name:
type: string
fullyQualifiedName:
type: string
description:
type: string
displayName:
type: string
deleted:
type: boolean
inherited:
type: boolean
href:
type: string
format: uri
UsageDetails:
required:
- dailyStats
- date
type: object
properties:
dailyStats:
$ref: '#/components/schemas/UsageStats'
weeklyStats:
$ref: '#/components/schemas/UsageStats'
monthlyStats:
$ref: '#/components/schemas/UsageStats'
date:
type: string
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT