{ "opencollection": "1.0.0", "info": { "name": "OpenMetadata APIs Agent Executions Metrics API", "version": "1.13" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Metrics", "type": "folder" }, "items": [ { "info": { "name": "Add a follower", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/metrics/:id/followers", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Metric" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a user identified by `userId` as followed of this Metric." }, { "info": { "name": "Bulk create or update metrics", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/metrics/bulk", "params": [ { "name": "async", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or update multiple metrics in a single operation." }, { "info": { "name": "List metrics", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/metrics", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "limit", "value": "", "type": "query" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of metrics before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of metrics after this cursor" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." } ] }, "docs": "Get a list of metrics. Use `fields` parameter to get only necessary fields." }, { "info": { "name": "Create a Metric", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/metrics", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Metric." }, { "info": { "name": "Create or update a metric", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/metrics", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new metric, if it does not exist or update an existing metric." }, { "info": { "name": "Get a Metric by fully qualified name.", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/metrics/name/:fqn", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Fully qualified name of the Metric" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." }, { "name": "includeRelations", "value": "", "type": "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." } ] }, "docs": "Get a Metric by fully qualified name." }, { "info": { "name": "Update a Metric using name.", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/metrics/name/:fqn", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Name of the Metric" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Metric using JsonPatch." }, { "info": { "name": "Delete a Metric by fully qualified name", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/metrics/name/:fqn", "params": [ { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "fqn", "value": "", "type": "path", "description": "Fully qualified name of the Metric" } ] }, "docs": "Delete a Metric by `fullyQualifiedName`." }, { "info": { "name": "Get a metric by Id", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/metrics/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the metric" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." }, { "name": "includeRelations", "value": "", "type": "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." } ] }, "docs": "Get a metric by `Id`." }, { "info": { "name": "Update a Metric", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/metrics/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Metric" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Metric using JsonPatch." }, { "info": { "name": "Delete a Metric by id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/metrics/:id", "params": [ { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "id", "value": "", "type": "path", "description": "Id of the Metric" } ] }, "docs": "Delete a Metric by `id`." }, { "info": { "name": "Asynchronously delete a Metric by id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/metrics/async/:id", "params": [ { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "id", "value": "", "type": "path", "description": "Id of the Metric" } ] }, "docs": "Asynchronously delete a Metric by `id`." }, { "info": { "name": "Remove a follower", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/metrics/:id/followers/:userId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Metric" }, { "name": "userId", "value": "", "type": "path", "description": "Id of the user being removed as follower" } ] }, "docs": "Remove the user identified `userId` as a follower of the Metric." }, { "info": { "name": "Get list of custom units of measurement", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/metrics/customUnits" }, "docs": "Get a list of all custom units of measurement that have been used in existing metrics. This helps UI provide autocomplete suggestions." }, { "info": { "name": "Get a version of the Metric", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/metrics/:id/versions/:version", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Metric" }, { "name": "version", "value": "", "type": "path", "description": "Metric version number in the form `major`.`minor`" } ] }, "docs": "Get a version of the Metric by given `id`" }, { "info": { "name": "List all entity versions within a time range", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/metrics/history", "params": [ { "name": "startTs", "value": "", "type": "query", "description": "Start timestamp in milliseconds since epoch" }, { "name": "endTs", "value": "", "type": "query", "description": "End timestamp in milliseconds since epoch" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of entity returned (1 to 1000000, default = 10)" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of entity versions before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of entity versions after this cursor" } ] }, "docs": "Get a paginated list of all entity versions within a given time range specified by `startTs` and `endTs` in milliseconds since epoch. " }, { "info": { "name": "List Metric versions", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/metrics/:id/versions", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the metric" } ] }, "docs": "Get a list of all the versions of a metric identified by `id`" }, { "info": { "name": "Restore a soft deleted Metric.", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/metrics/restore", "body": { "type": "json", "data": "{}" } }, "docs": "Restore a soft deleted Metric." }, { "info": { "name": "Update Vote for a Metric", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/metrics/:id/vote", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Entity" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update vote for a Metric" } ] } ], "bundled": true }