Get time-series tablet metrics
Authorization
A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
Service Token Accesses
read_branch, delete_branch, create_branch, connect_production_branch, connect_branch
OAuth Scopes
| Resource | Scopes |
|---|---|
| Organization | read_branches |
| Database | read_branches |
| Branch | read_branch |
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Organization name slug from list_organizations. Example: acme.
Database name slug from list_databases. Example: app-db.
Branch name from list_branches. Example: main.
Query Parameters
Metric names to retrieve
replication_lag, vreplication_lag, pod_cpu_usage, pod_memory_usage, pod_queries, pod_rows_read, pod_iops, primary_cpu_usage, primary_memory_usage, primary_iops, primary_queries, primary_rows_read, primary_rows_written, shard_storage_usage, shard_storage_available Named time period to retrieve. Defaults to 12h.
15m, 1h, 3h, 6h, 12h, 1d, 2d, 7d, 8d Start of a custom time range as an ISO 8601 timestamp
End of a custom time range as an ISO 8601 timestamp
Number of data points to return
Filter by keyspace
Filter by shard
Filter by pod
Filter by workflow ID

