List Stat Descriptors

GET

/storage/v1/workspaces/{workspace}/statDescriptors

curl --request GET \
  --url https://example.com/storage/v1/workspaces/example/statDescriptors

Returns the static UI metadata (code, display name, unit, description) for every stat in BucketAggregateStats, so the console renders labels and units without hardcoding them. The registry is version-bound and engine-neutral; workspace scopes authorization only.

Parameters

Path Parameters

workspace

required

string

The workspace the caller is authorized in

Responses

200

OK

Media type application/json

List Stat Descriptors Response

The full static descriptor registry — one descriptor per stat in BucketAggregateStats.

object

stat_descriptors

The stat descriptors, one per BucketAggregateStats stat field.

Array<object>Output only

Stat Descriptor

Static UI metadata for one stat in BucketAggregateStats: the label and unit the console renders for that stat’s KPI card, keyed by the stat’s field name. Served by ListStatDescriptors so the UI never hardcodes labels or units.

object

code

The stat’s field name in BucketAggregateStats (for example, “total_size_bytes”).

stringOutput only

display_name

The human-facing card label (for example, “Total Stored”).

stringOutput only

unit

The unit the stat’s value is expressed in.

string format: enum Output only

Allowed values: STAT_UNIT_UNSPECIFIED STAT_UNIT_BYTES STAT_UNIT_COUNT STAT_UNIT_MONEY

description

A short description of what the stat measures.

stringOutput only

Example

{
  "stat_descriptors": [
    {
      "unit": "STAT_UNIT_UNSPECIFIED"
    }
  ]
}

default

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

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

integer format: int32

message

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.

string

details

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

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}