Skip to main content

get-dimensions 

dci get-dimensions [flags]

Returns a dimension by type and key.

Flags​

--type: (string enum:"datetime","fixed","optional","label","tag","project_label","system_label","attribution","attribution_group","allocation","allocation_rule","gke","gke_label") 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.

--id: (string)

Responses​

200 (application/json)​

OK - The dimension returned.

{
  "type": "object",
  "description": "Dimension metadata returned by the API.",
  "properties": {
    "id": {
      "type": "string"
    },
    "label": {
      "type": "string"
    },
    "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."
      }
    },
    "values": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Single value entry used by some dimension endpoints.",
        "properties": {
          "cloud": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    }
  }
}

400 (application/json)​

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)​

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)​

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)​

Not Found - The requested resource does not exist.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

500 (application/json)​

Internal Server Error - Something went wrong with the DoiT API server.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: get-dimensions, getdimensions