list-dimensions

dci list-dimensions [flags]

Returns a list of the dimensions that your account has access to.

Flags

--max-results: (integer format:int64 default:50)

--page-token: (string)

--filter: (string)

--sort-by: (string enum:"type","label","key","timestamp")

--sort-order: (string enum:"asc","desc")

Output

OK - The request succeeded.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

Field	Type	Description
dimensions	array of object	Array of dimensions.
dimensions[].id	string	The identifier of the dimension.
dimensions[].label	string	The label of the dimension.
dimensions[].type	string	Dimension filter type. Always pair type with id on scope filters. Discover valid id + type pairs for your account with GET /analytics/v1/dimensions. allocation_rule replaces attribution; allocation replaces attribution_group. One of: "datetime", "fixed", "optional", "label", "tag", "project_label", "system_label", "attribution", "attribution_group", "allocation", "allocation_rule", "gke", ….
pageToken	string
rowCount	integer (int64)

Raw JSON schema

{
  "type": "object",
  "description": "Paged list of available dimensions.",
  "properties": {
    "dimensions": {
      "type": "array",
      "description": "Array of dimensions.",
      "items": {
        "type": "object",
        "description": "Summary information about a dimension.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The identifier of the dimension."
          },
          "label": {
            "type": "string",
            "description": "The label of the dimension."
          },
          "type": {
            "description": "Dimension filter type. Always pair `type` with `id` on scope filters. Discover valid `id` + `type` pairs for your account with `GET /analytics/v1/dimensions`. `allocation_rule` replaces `attribution`; `allocation` replaces `attribution_group`.",
            "type": "string",
            "enum": [
              "datetime",
              "fixed",
              "optional",
              "label",
              "tag",
              "project_label",
              "system_label",
              "attribution",
              "attribution_group",
              "allocation",
              "allocation_rule",
              "gke",
              "gke_label"
            ],
            "x-enumDescriptions": {
              "fixed": "Standard built-in billing dimensions (Service, Provider, Project/Account ID, SKU, Region, etc.).",
              "label": "Customer-defined resource labels; id is the label key, values are label values.",
              "tag": "AWS cost allocation tags; id is the tag key.",
              "project_label": "Google Cloud project-level labels; id is the label key.",
              "system_label": "DoiT- or provider-generated system labels; id is the system label key.",
              "optional": "Console grouping for label/tag keys; use label, tag, project_label, or system_label in API scopes.",
              "datetime": "Time dimensions (Year, Month, Day) for date-based filtering or grouping.",
              "allocation_rule": "Allocation rule filter; id must be allocation_rule, values are rule IDs.",
              "allocation": "Allocation group filter; id is the allocation group ID.",
              "gke": "Google Kubernetes Engine cost-allocation dimensions.",
              "gke_label": "GKE workload labels; id is the label key.",
              "attribution": "Deprecated. Use allocation_rule.",
              "attribution_group": "Deprecated. Use allocation."
            }
          }
        }
      }
    },
    "pageToken": {
      "type": "string"
    },
    "rowCount": {
      "type": "integer",
      "format": "int64"
    }
  }
}

Errors

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status	Exit code	Error code	Meaning
400	30	VALIDATION_ERROR	The arguments or request body were rejected. Review the command's flags and payload.
401	10	AUTHENTICATION_FAILED	Not signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
403	11	PERMISSION_DENIED	The DoiT user or the active customer context does not have access.
404	20	RESOURCE_NOT_FOUND	The requested resource does not exist. Check the identifier argument.

Aliases: listdimensions