# Collate Metrics API

**Canonical:** https://apis.io/apis/collate/collate-metrics-api/  
**Provider:** Collate — https://apis.io/providers/collate/  
**Base URL:** https://sandbox.open-metadata.org/api/v1  
**Documentation:** https://docs.open-metadata.org/latest/api-reference

Collate Metrics API is one of 107 APIs that [Collate](https://apis.io/providers/collate/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Metrics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

`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`.

## Operations (26)

| Method | Path | Summary |
|---|---|---|
| PUT | `/v1/metrics/{id}/followers` | Add a follower |
| PUT | `/v1/metrics/bulk` | Bulk create or update metrics |
| GET | `/v1/metrics` | List metrics |
| PUT | `/v1/metrics` | Create or update a metric |
| POST | `/v1/metrics` | Create a Metric |
| GET | `/v1/metrics/name/{fqn}` | Get a Metric by fully qualified name |
| DELETE | `/v1/metrics/name/{fqn}` | Delete a Metric by fully qualified name |
| PATCH | `/v1/metrics/name/{fqn}` | Update a Metric using name |
| GET | `/v1/metrics/{id}` | Get a metric by Id |
| DELETE | `/v1/metrics/{id}` | Delete a Metric by id |
| PATCH | `/v1/metrics/{id}` | Update a Metric |
| DELETE | `/v1/metrics/async/{id}` | Asynchronously delete a Metric by id |
| DELETE | `/v1/metrics/{id}/followers/{userId}` | Remove a follower |
| GET | `/v1/metrics/name/{name}/export` | Export metrics in CSV format |
| GET | `/v1/metrics/name/{name}/exportAsync` | Export metrics in CSV format asynchronously |
| GET | `/v1/metrics/{id}/context` | Get the AI context for an entity by id |
| GET | `/v1/metrics/name/{fqn}/context` | Get the AI context for an entity by fully qualified name |
| GET | `/v1/metrics/documentation/csv` | Get CSV documentation for metric import/export |
| GET | `/v1/metrics/customUnits` | Get list of custom units of measurement |
| GET | `/v1/metrics/{id}/versions/{version}` | Get a version of the Metric |
| PUT | `/v1/metrics/name/{name}/import` | Import metrics from CSV to create or update metrics |
| PUT | `/v1/metrics/name/{name}/importAsync` | Import metrics from CSV asynchronously |
| GET | `/v1/metrics/history` | List all entity versions within a time range |
| GET | `/v1/metrics/{id}/versions` | List Metric versions |
| PUT | `/v1/metrics/restore` | Restore a soft deleted Metric |
| PUT | `/v1/metrics/{id}/vote` | Update Vote for a Metric |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/collate/refs/heads/main/openapi/collate-metrics-api-openapi.yml
- **Documentation** — https://docs.open-metadata.org/latest/api-reference
- **APIReference** — https://docs.open-metadata.org/latest/api-reference

## Other Collate APIs (12)

- [Collate Activity Stream API](https://apis.io/apis/collate/collate-activity-stream-api/)
- [Collate Agent Executions API](https://apis.io/apis/collate/collate-agent-executions-api/)
- [Collate AI Applications API](https://apis.io/apis/collate/collate-ai-applications-api/)
- [Collate AI Audit Reports API](https://apis.io/apis/collate/collate-ai-audit-reports-api/)
- [Collate AI Context API](https://apis.io/apis/collate/collate-ai-context-api/)
- [Collate AI Framework Controls API](https://apis.io/apis/collate/collate-ai-framework-controls-api/)
- [Collate AI Governance API](https://apis.io/apis/collate/collate-ai-governance-api/)
- [Collate AI Governance Frameworks API](https://apis.io/apis/collate/collate-ai-governance-frameworks-api/)
- [Collate AI Governance Policies API](https://apis.io/apis/collate/collate-ai-governance-policies-api/)
- [Collate Announcements API](https://apis.io/apis/collate/collate-announcements-api/)
- [Collate API Collections API](https://apis.io/apis/collate/collate-api-collections-api/)
- [Collate API Endpoint API](https://apis.io/apis/collate/collate-api-endpoint-api/)

## Tags

Metrics

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/collate/collate-metrics-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/collate/.