DocumentationAPI reference

Rust · 0.1.0

List All User Stats

GET /api/v1/users:stats

UserService · UserService_ListAllUserStats

Protocol-derived reference. Authorization and instance policy still apply. Schema descriptions are inherited from the MIT-licensed application contract; examples here are not executed against a live server.

Access

Anonymous calls are allowed only when the instance permits public access. Authenticated calls remain subject to resource visibility and operation-specific filtering.

Counts follow readable content

Memo statistics are computed using the caller's current audience and filter, not unrestricted global counts. GetUserStats exposes attachmentStorageBytes only to the user themself. Do not compare results from different identities as if they had the same visibility.

Request

ListAllUserStats returns statistics for all users.

GET/api/v1/users:stats

Parameters

Name / locationType / requirementDescription
state
query
string (enum)
STATE_UNSPECIFIED · NORMAL · ARCHIVED
Not marked required in OpenAPI
Optional. The state of memos to include. Defaults to NORMAL.
filter
query
string
Not marked required in OpenAPI
Optional. Filter to apply to memo stats. Uses the same filter syntax as ListMemos.

Request body

No request body is declared.

Responses

200 · OK

application/json · ListAllUserStatsResponse

default · Default error response

application/json · Status

Complete operation definition

All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.

Open JSON definition
{
  "tags": [
    "UserService"
  ],
  "description": "ListAllUserStats returns statistics for all users.",
  "operationId": "UserService_ListAllUserStats",
  "parameters": [
    {
      "name": "state",
      "in": "query",
      "description": "Optional. The state of memos to include. Defaults to NORMAL.",
      "schema": {
        "enum": [
          "STATE_UNSPECIFIED",
          "NORMAL",
          "ARCHIVED"
        ],
        "type": "string",
        "format": "enum"
      }
    },
    {
      "name": "filter",
      "in": "query",
      "description": "Optional. Filter to apply to memo stats.\n Uses the same filter syntax as ListMemos.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListAllUserStatsResponse"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}