# Get database usage metrics

GET`/v1/databases/{databaseId}/usage`

Returns usage metrics for the specified database.

## [Authorization](#authorization)

AuthorizationBearer \<token>

OAuth2 authentication

In: `header`

Scope: `workspace:admin, offline_access`

## [Path Parameters](#path-parameters)

databaseId\*string

Match`^(db_)?([cC][^\s-]{8,}|[a-z0-9]+)$`

## [Query Parameters](#query-parameters)

startDate?string

Start date for metrics query. Defaults to start of current month if not provided.

Format`date-time`

endDate?string

End date for metrics query. Will be set to end of day if a future date is provided. Defaults to current date if not provided.

Format`date-time`

## [Response Body](#response-body)

### `application/json`

### `application/json`

### `application/json`

### `application/json`

### `application/json`

### `application/json`

::::tabs
:::tab{title="cURL"}
```
curl -X GET "https://example.com/v1/databases/string/usage"
```
:::

:::tab{title="JavaScript"}
```
{
  "period": {
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z"
  },
  "metrics": {
    "operations": {
      "used": 0,
      "unit": "ops"
    },
    "storage": {
      "used": 0,
      "unit": "GiB"
    }
  },
  "generatedAt": "2019-08-24T14:15:22Z"
}
```
:::

:::tab{title="Go"}
:::

:::tab{title="Python"}
:::

:::tab{title="Java"}
:::

:::tab{title="C#"}
:::

:::tab{title="Rust"}
:::
::::

## Related pages

- [Authentication & Tools](./authentication-tools-index.md)
- [Build](./build-index.md)
- [Changelog](../changelog.md)
- [Concepts](./concepts-index.md)
- [Console commands](./console-commands-index.md)
- [Contract Authoring](./contract-authoring-index.md)
- [Core Concepts](./core-concepts-index.md)
- [Data Modeling](./data-modeling-index.md)
- [Database](./database-index.md)
- [DB commands](./db-commands-index.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.