Usage Reports

Endpoints that serve the pre-generated monthly usage summaries under /api/v1/dashboard/summary (KubeDB, KubeStash, KubeVault, Voyager) and the DBaaS namespace billing reports under /api/v1/dbaas/billing.

All paths on this page are relative to /api/v1. Every endpoint requires Authorization: token <YOUR_TOKEN> and resolves the acting organization from the org query parameter (?org=<org-slug>). The /dashboard/summary/* routes require view_usage_analytics:site_admin; the /dbaas/billing/* routes require org ownership when an org is set. This group is available only on billing-enabled deployments.

About usage-report views

Usage summaries are generated per month and per product. The individual view endpoints (objects, clusters, namespaces, gks, contracts, quota-history, cluster-mode) all return a UsageView — a complex, deeply-nested aggregation structure whose exact shape varies by product and by the view_type query parameter. It is modeled as a free-form JSON object, so the examples below show the envelope rather than an exhaustive field list.

Common path parameters for the summary routes:

Name	Type	Description
`year`	string	Four-digit report year (e.g. `2026`).
`month`	string	Report month (e.g. `06` or `June`, per the generated-months list).

Monthly summary

GET /dashboard/monthly-summary/{resourceType}

Returns the per-month usage totals for one product, newest month first, with month-over-month change percentages.

Auth: token; site-admin (view_usage_analytics:site_admin). Requires ?org=.
Path parameters:

Name	Type	Description
`resourceType`	string	Product alias: `kubedb`, `stash`, `vault`, or `voyager`.

Query parameters:

Name	Type	Required	Description
`org`	string	yes	Organization slug.
`period_start`	string	no	First month to include, `YYYY-MM`. Defaults to five months before the current month (a six-month window).
`period_end`	string	no	Last month to include, `YYYY-MM`. Only read when `period_start` is given; defaults to the current month.

When an explicit period is given it is clamped to the months that actually have a generated summary; if it overlaps none, the response comes back with an empty months array. The requested range must not exceed 24 months.

Response: 200 OK — a MonthlySummaryResponse:

{
  "resourceType": "kubedb",
  "months": [
    {
      "year": 2026,
      "month": 6,
      "cpuCoreMonth": 12.5,
      "memoryGiBMonth": 48.25,
      "instances": 7,
      "cpuChangeFromPrev": 4.2,
      "memoryChangeFromPrev": -1.8
    },
    {
      "year": 2026,
      "month": 5,
      "cpuCoreMonth": 12.0,
      "memoryGiBMonth": 49.1,
      "instances": 7
    }
  ]
}

Field	Type	Description
`resourceType`	string	Echo of the path parameter.
`months`	array	Monthly rows, most recent first.
`months[].year`	integer	Calendar year.
`months[].month`	integer	Calendar month, `1`–`12`.
`months[].cpuCoreMonth`	number	CPU core-months consumed.
`months[].memoryGiBMonth`	number	Memory GiB-months consumed.
`months[].instances`	integer	Instance count for the month.
`months[].cpuChangeFromPrev`	number	Percentage change vs. the previous (older) month; omitted on the oldest row.
`months[].memoryChangeFromPrev`	number	Percentage change vs. the previous (older) month; omitted on the oldest row.

Errors: 400 for an unknown resourceType, a period_start/period_end that is not YYYY-MM, a period_start after period_end, or a range longer than 24 months.

Generated months

GET /dashboard/summary/generated-months

Returns the year/month combinations for which a usage summary has been generated for the owner.

Auth: token; site-admin (view_usage_analytics:site_admin). Requires ?org=.
Query parameters:

Name	Type	Required	Description
`org`	string	yes	Organization slug.

Response: 200 OK — a GeneratedDates object. yearMonthList is keyed by year, with a list of generated month names per year.

{
  "yearMonthList": {
    "2026": ["January", "February", "March", "April", "May", "June"]
  }
}

curl -H "Authorization: token $AKP_TOKEN" \
  "https://<akp-host>/api/v1/dashboard/summary/generated-months?org=appscode"

GET /dashboard/summary/object-quota-history/clusters/{clusterUID}/objects/{objectID}

Returns the quota-history usage view for a specific KubeDB object (not scoped to a month).

Auth: token; site-admin (view_usage_analytics:site_admin). Requires ?org=.
Path parameters:

Name	Type	Description
`clusterUID`	string	Cluster UID.
`objectID`	string	Object (database) ID.

Response: 200 OK — a UsageView (free-form object quota-history view).

KubeDB usage views

All routes below are rooted at /dashboard/summary/{year}/{month}/usage-report/products/kubeDb/views and require view_usage_analytics:site_admin and ?org=. Each returns a UsageView.

GET …/kubeDb/views/objects-usage-view

Returns the KubeDB objects usage view for the month, enriched with each object’s daily event count.

Query parameters (all optional): view_type (string), group (string), kind (string), clusterUID (string), namespace (string), namespaceUID (string).
Response: 200 OK — a UsageView. 400 on invalid parameters.

{
  "...": "free-form KubeDB objects usage view (varies by view_type)"
}

GET …/kubeDb/views/clusters-usage-view

Returns the KubeDB clusters usage view for the month.

Query parameters (all optional): view_type (string), group (string), kind (string), contractID (integer).
Response: 200 OK — a UsageView. 400 on invalid parameters.

GET …/kubeDb/views/namespaces-usage-view

Returns the KubeDB namespaces usage view for the month.

Query parameters (all optional): view_type (string), clusterUID (string).
Response: 200 OK — a UsageView. 400 on invalid parameters.

GET …/kubeDb/views/gks-usage-view

Returns the KubeDB “GKs” (group/kind) usage view for the month, with the total monthly usage matrix.

Query parameters (all optional): view_type (string), clusterUID (string).
Response: 200 OK — a UsageView. 400 on invalid parameters.

GET …/kubeDb/views/contracts-usage-view

Returns the KubeDB contracts usage view for the month.

Query parameters (all optional): view_type (string).
Response: 200 OK — a UsageView. 400 on invalid parameters.

GET …/kubeDb/views/object-quota-history-summaries-view

Returns the month-specific KubeDB object quota-history summaries.

Response: 200 OK — a UsageView.

GET …/kubeDb/views/object-quota-history-summaries-view/clusters/{clusterUID}/objects/{objectID}

Returns the month-specific KubeDB object quota-history summary for a specific cluster/object.

Path parameters: clusterUID (string), objectID (string).
Response: 200 OK — a UsageView.

GET …/kubeDb/views/objects-cluster-mode-usage-view

Returns the KubeDB objects cluster-mode usage history list for the month.

Response: 200 OK — a UsageView.

GET …/kubeDb/views/objects-cluster-mode-usage-view/clusters/{clusterUID}/objects/{objectID}

Returns the KubeDB cluster-mode usage history for a specific cluster/object.

Path parameters: clusterUID (string), objectID (string).
Response: 200 OK — a UsageView.

KubeStash, KubeVault, and Voyager usage views

Each of these products exposes a clusters-usage-view and a contracts-usage-view for the month, rooted at /dashboard/summary/{year}/{month}/usage-report/products/{product}/views. They require view_usage_analytics:site_admin and ?org=, and each returns a UsageView.

GET …/kubeStash/views/clusters-usage-view

Returns the KubeStash clusters usage view for the month.

Query parameters (all optional): view_type (string), contractID (integer).
Response: 200 OK — a UsageView. 400 on invalid parameters.

GET …/kubeStash/views/contracts-usage-view

Returns the KubeStash contracts usage view for the month.

Query parameters (all optional): view_type (string).
Response: 200 OK — a UsageView. 400 on invalid parameters.

GET …/kubeVault/views/clusters-usage-view

Returns the KubeVault clusters usage view for the month.

Query parameters (all optional): view_type (string), contractID (integer).
Response: 200 OK — a UsageView. 400 on invalid parameters.

GET …/kubeVault/views/contracts-usage-view

Returns the KubeVault contracts usage view for the month.

Query parameters (all optional): view_type (string).
Response: 200 OK — a UsageView. 400 on invalid parameters.

GET …/voyager/views/clusters-usage-view

Returns the Voyager clusters usage view for the month.

Query parameters (all optional): view_type (string), contractID (integer).
Response: 200 OK — a UsageView. 400 on invalid parameters.

GET …/voyager/views/contracts-usage-view

Returns the Voyager contracts usage view for the month.

Query parameters (all optional): view_type (string).
Response: 200 OK — a UsageView. 400 on invalid parameters.

Download

GET /dashboard/summary/{year}/{month}/download

Renders and returns the KubeDB usage summary as a PDF document for the given month.

Auth: token; site-admin (view_usage_analytics:site_admin). Requires ?org=.
Path parameters: year (string), month (string).
Response: 200 OK — the usage-report PDF (application/pdf, or application/octet-stream) as a binary body.

curl -H "Authorization: token $AKP_TOKEN" \
  "https://<akp-host>/api/v1/dashboard/summary/2026/June/download?org=appscode" \
  -o usage-report.pdf

DBaaS billing reports

These routes are rooted at /dbaas/billing/reports, require a token and ?org=, and are checked for org ownership when an org is set (rather than site-admin). Each returns a pre-marshaled report view, modeled as a free-form UsageView.

GET /dbaas/billing/reports/namespaces

Returns the DBaaS namespace report list (V1) for the owner.

Auth: token; org-ownership when org is set. Requires ?org=.
Response: 200 OK — a UsageView (free-form namespace report list).

curl -H "Authorization: token $AKP_TOKEN" \
  "https://<akp-host>/api/v1/dbaas/billing/reports/namespaces?org=appscode"

GET /dbaas/billing/reports/clusters/{clusterID}/namespaces/{namespaceName}

Returns the DBaaS namespace report (V1) for a specific cluster/namespace.

Auth: token; org-ownership when org is set. Requires ?org=.
Path parameters:

Name	Type	Description
`clusterID`	string	Cluster ID.
`namespaceName`	string	Namespace name.

Response: 200 OK — a UsageView (free-form namespace report).

KubeDB Operator

KubeDB Platform

Internal DBaaS for platform teams

Automate database operations with GitOps

Multi-tenant database infrastructure

White-labeled DBaaS offering

Run DBaaS in secure, offline clusters

PostgreSQL

MySQL

MariaDB

Microsoft SQL Server

Oracle

Percona XtraDB

SAP HanaDB

IBM DB2

MongoDB

Cassandra

DocumentDB

Redis

Valkey

Memcached

Ignite

Hazelcast

Elasticsearch

OpenSearch

Solr

Kafka

RabbitMQ

ClickHouse

Druid

SingleStore

Milvus

Qdrant

Weaviate

Neo4j

PgBouncer

Pgpool

ProxySQL

ZooKeeper

Amazon EKS

Google GKE

Microsoft AKS

Red Hat OpenShift

SUSE Rancher

Nutanix Kubernetes Platform

Mirantis Kubernetes Engine

VMware vSphere Kubernetes Service

Alliance Partners

Channel Partners

Managed Service Providers

Operator Documentation

Platform Documentation

Orange Telecom powers its digital future with KubeDB

10× lower costs. 2× faster performance. All with KubeDB.

White-label DBaaS live in 1 month — serving 20,000+ customers

Deploy Cassandra via Kubernetes Cassandra Operator

How to Deploy ClickHouse via Kubernetes ClickHouse Operator

Deploy Memcached using Kubernetes Memcached Operator

Blog

Database Branching at Kubernetes Scale

ClickHouse Ops Requests - Day 2 Lifecycle Management for ClickHouse Using KubeDB (Part-2)

Provision and Manage Milvus on Kubernetes using KubeDB

Provision and Manage Weaviate on Kubernetes using KubeDB

Videos