Get instance resource usage statistics

2 status codes

200Returns instance resource usage statistics, including database size, local storage size in bytes, and the time the snapshot was generated.

databaseobjectoptional

Database size statistics.

localStorageBytesstringoptional

Recursive size of the data directory in bytes. -1 if unavailable.

generatedTimestringoptional

Server-side timestamp when the snapshot was generated.

defaultReturned when the request fails; includes an error code, a developer-facing message, and optional error details.

codeintegeroptional

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestringoptional

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsarray<object>optional

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Error handling

Access is restricted to the admin role. Use an authenticated administrator account to retrieve instance statistics.

import { Client } from "memos-unofficial-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
});

const result = await client.stats.list();

{
  "database": {
    "driver": "example_value",
    "sizeBytes": "example_value"
  },
  "localStorageBytes": "example_value",
  "generatedTime": "2026-01-15T09:00:00Z"
}

Response

Errors