Skip to main content

list-dimensions 

restish dci list-dimensions [flags]

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

Flags​

--max-results: (string default:"500")

--page-token: (string)

--filter: (string)

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

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

Responses​

200 (application/json)​

OK - The request succeeded.

{
  "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": "Enumeration of supported dimension/filter types.",
            "type": "string",
            "enum": [
              "datetime",
              "fixed",
              "optional",
              "label",
              "tag",
              "project_label",
              "system_label",
              "attribution",
              "attribution_group",
              "gke",
              "gke_label"
            ]
          }
        }
      }
    },
    "pageToken": {
      "type": "string"
    },
    "rowCount": {
      "type": "integer",
      "format": "int64"
    }
  }
}

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."
    }
  }
}

Aliases: list-dimensions, listdimensions