---
updatedAt: 2026-04-29T23:08:20.000Z
agentTools:
  projectIndex: https://docs.bigeye.com/llms.txt
---

# Get dimension

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Observability",
    "version": "version not set"
  },
  "paths": {
    "/api/v1/dimension/{dimensionId}": {
      "get": {
        "operationId": "DimensionService_GetDimension",
        "parameters": [
          {
            "in": "path",
            "name": "dimensionId",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/generatedDimension"
                }
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runtimeError"
                }
              }
            }
          }
        },
        "summary": "Get dimension",
        "tags": [
          "DimensionService"
        ]
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    },
    {
      "Personal_API_Key": []
    }
  ],
  "servers": [
    {
      "url": "https://app.bigeye.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      },
      "Personal_API_Key": {
        "description": "Add 'apikey ' to the beginning of your api key",
        "in": "header",
        "name": "Authorization",
        "type": "apiKey"
      }
    },
    "schemas": {
      "generatedDimension": {
        "properties": {
          "description": {
            "type": "string"
          },
          "entityInfo": {
            "$ref": "#/components/schemas/generatedEntityInfo"
          },
          "id": {
            "format": "int32",
            "type": "integer"
          },
          "instanceTypesWithCounts": {
            "items": {
              "$ref": "#/components/schemas/generatedInstanceTypeWithCounts"
            },
            "type": "array"
          },
          "name": {
            "type": "string"
          },
          "topLevelCategory": {
            "$ref": "#/components/schemas/generatedTopLevelCategory"
          }
        },
        "type": "object"
      },
      "generatedDimensionInstanceType": {
        "default": "DIMENSION_INSTANCE_TYPE_UNSPECIFIED",
        "enum": [
          "DIMENSION_INSTANCE_TYPE_UNSPECIFIED",
          "DIMENSION_INSTANCE_TYPE_METRIC",
          "DIMENSION_INSTANCE_TYPE_DELTA",
          "DIMENSION_INSTANCE_TYPE_CUSTOM_RULE",
          "DIMENSION_INSTANCE_TYPE_JOIN_RULE",
          "DIMENSION_INSTANCE_TYPE_TEMPLATE_METRIC"
        ],
        "type": "string"
      },
      "generatedEntityInfo": {
        "properties": {
          "createdBy": {
            "format": "int32",
            "type": "integer"
          },
          "createdEpochSeconds": {
            "format": "int64",
            "type": "string"
          },
          "updatedBy": {
            "format": "int32",
            "type": "integer"
          },
          "updatedEpochSeconds": {
            "format": "int64",
            "type": "string"
          }
        },
        "type": "object"
      },
      "generatedInstanceTypeWithCounts": {
        "properties": {
          "count": {
            "format": "int64",
            "type": "string"
          },
          "instanceType": {
            "$ref": "#/components/schemas/generatedDimensionInstanceType"
          },
          "isOverride": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "generatedTopLevelCategory": {
        "default": "TOP_LEVEL_CATEGORY_UNSPECIFIED",
        "enum": [
          "TOP_LEVEL_CATEGORY_UNSPECIFIED",
          "TOP_LEVEL_CATEGORY_PIPELINE_RELIABILITY",
          "TOP_LEVEL_CATEGORY_DATA_QUALITY"
        ],
        "title": "Dimensions",
        "type": "string"
      },
      "protobufAny": {
        "properties": {
          "typeUrl": {
            "type": "string"
          },
          "value": {
            "format": "byte",
            "type": "string"
          }
        },
        "type": "object"
      },
      "runtimeError": {
        "properties": {
          "code": {
            "format": "int32",
            "type": "integer"
          },
          "details": {
            "items": {
              "$ref": "#/components/schemas/protobufAny"
            },
            "type": "array"
          },
          "error": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  }
}
```