---
title: "Get segment dimensions"
method: GET
path: "/api/v1/projects/{projectUuid}/dataCatalog/{tableName}/segment-dimensions"
tags: ["Catalog"]
---

# Get segment dimensions

`GET /api/v1/projects/{projectUuid}/dataCatalog/{tableName}/segment-dimensions`

Get dimensions that can be used to segment metrics

## Path parameters

- `projectUuid` string, required
- `tableName` string, required

## Response `200`

Success

- ApiSegmentDimensionsResponse
  - `results` CompiledDimension[], required
    - `fieldType` 'dimension', required
    - `type` 'string' | 'number' | 'timestamp' | 'date' | 'boolean', required
    - `name` string, required
    - `label` string, required
    - `table` string, required
    - `tableLabel` string, required
    - `sql` string, required
    - `description` string
    - `source` Source
      - `content` string, required
      - `highlight` object
        - `end` SourcePosition, required
          - `character` number, double, required
          - `line` number, double, required
        - `start` SourcePosition, required
          - `character` number, double, required
          - `line` number, double, required
      - `range` object, required
        - `end` SourcePosition, required
          - `character` number, double, required
          - `line` number, double, required
        - `start` SourcePosition, required
          - `character` number, double, required
          - `line` number, double, required
      - `path` string, required
    - `hidden` boolean, required
    - `compact` union
      - 'auto' | 'thousands' | 'millions' | 'billions' | 'trillions' | 'kilobytes' | 'megabytes' | 'gigabytes' | 'terabytes' | 'petabytes' | 'kibibytes' | 'mebibytes' | 'gibibytes' | 'tebibytes' | 'pebibytes'
      - 'K' | 'thousand' | 'M' | 'million' | 'B' | 'billion' | 'T' | 'trillion' | 'KB' | 'kilobyte' | 'MB' | 'megabyte' | 'GB' | 'gigabyte' | 'TB' | 'terabyte' | 'PB' | 'petabyte' | 'KiB' | 'kibibyte' | 'MiB' | 'mebibyte' | 'GiB' | 'gibibyte' | 'TiB' | 'tebibyte' | 'PiB' | 'pebibyte'
    - `round` number, double
    - `format` union
      - 'km' | 'mi' | 'si' | 'usd' | 'gbp' | 'eur' | 'jpy' | 'dkk' | 'id' | 'percent'
      - string
    - `separator` 'default' | 'commaPeriod' | 'spacePeriod' | 'periodComma' | 'noSeparatorPeriod' | 'apostrophePeriod'
    - `groupLabel` string
    - `groups` string[]
    - `urls` FieldUrl[]
      - `label` string, required
      - `url` string, required
    - `index` number, double
    - `tags` string[]
    - `parameterReferences` string[]
    - `group` string
    - `requiredAttributes` RecordStringStringOrStringArray — Construct a type with a set of properties K of type T
    - `anyAttributes` RecordStringStringOrStringArray — Construct a type with a set of properties K of type T
    - `timeInterval` 'RAW' | 'YEAR' | 'QUARTER' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND' | 'MILLISECOND' | 'DAY_OF_WEEK_INDEX' | 'DAY_OF_MONTH_NUM' | 'DAY_OF_YEAR_NUM' | 'WEEK_NUM' | 'MONTH_NUM' | 'QUARTER_NUM' | 'YEAR_NUM' | 'DAY_OF_WEEK_NAME' | 'MONTH_NAME' | 'QUARTER_NAME' | 'HOUR_OF_DAY_NUM' | 'MINUTE_OF_HOUR_NUM'
    - `timeIntervalLabel` string — Overridden display label for this dimension's grain (project `granularity_labels`); undefined when no override — callers fall back to `timeFrameConfigs[timeInterval].getLabel()`.
    - `timeIntervalBaseDimensionName` string
    - `timeIntervalBaseDimensionType` 'string' | 'number' | 'timestamp' | 'date' | 'boolean'
    - `customTimeInterval` string
    - `isAdditionalDimension` boolean
    - `skipTimezoneConversion` boolean
    - `timestampDomain` 'aware' | 'naive' — Whether a TIMESTAMP column stores an instant ('aware') or a bare wall clock ('naive'). Absent means unknown — never assume 'aware' for a missing value.
    - `colors` RecordStringString — Construct a type with a set of properties K of type T
    - `isIntervalBase` boolean
    - `aiHint` union
      - string
      - string[]
    - `formatOptions` CustomFormat
      - `type` 'default' | 'percent' | 'currency' | 'number' | 'id' | 'date' | 'timestamp' | 'bytes_si' | 'bytes_iec' | 'custom', required
      - `round` number, double — Number of decimal places
      - `separator` 'default' | 'commaPeriod' | 'spacePeriod' | 'periodComma' | 'noSeparatorPeriod' | 'apostrophePeriod'
      - `currency` string — Currency code (e.g., USD, GBP, EUR)
      - `compact` union
        - 'auto' | 'thousands' | 'millions' | 'billions' | 'trillions' | 'kilobytes' | 'megabytes' | 'gigabytes' | 'terabytes' | 'petabytes' | 'kibibytes' | 'mebibytes' | 'gibibytes' | 'tebibytes' | 'pebibytes'
        - 'K' | 'thousand' | 'M' | 'million' | 'B' | 'billion' | 'T' | 'trillion' | 'KB' | 'kilobyte' | 'MB' | 'megabyte' | 'GB' | 'gigabyte' | 'TB' | 'terabyte' | 'PB' | 'petabyte' | 'KiB' | 'kibibyte' | 'MiB' | 'mebibyte' | 'GiB' | 'gibibyte' | 'TiB' | 'tebibyte' | 'PiB' | 'pebibyte'
      - `prefix` string — Prefix to prepend to formatted values
      - `suffix` string — Suffix to append to formatted values
      - `timeInterval` 'RAW' | 'YEAR' | 'QUARTER' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND' | 'MILLISECOND' | 'DAY_OF_WEEK_INDEX' | 'DAY_OF_MONTH_NUM' | 'DAY_OF_YEAR_NUM' | 'WEEK_NUM' | 'MONTH_NUM' | 'QUARTER_NUM' | 'YEAR_NUM' | 'DAY_OF_WEEK_NAME' | 'MONTH_NAME' | 'QUARTER_NAME' | 'HOUR_OF_DAY_NUM' | 'MINUTE_OF_HOUR_NUM'
      - `custom` string — Custom format string
    - `caseSensitive` boolean
    - `image` object
      - `fit` string
      - `height` number, double
      - `width` number, double
      - `url` string, required
    - `richText` string
    - `filterAutocomplete` FilterAutocompleteConfig
      - `labelDimension` string
      - `fetchFromWarehouse` boolean, required
      - `values` FilterAutocompleteValue[]
        - `label` string
        - `value` string, required
    - `spotlight` object
      - `segmentBy` boolean
      - `filterBy` boolean
    - `compiledTimestampFilters` CompiledMetricTimestampFilter[]
      - `compiledSql` string, required
      - `fieldId` string, required
      - `id` string, required
    - `compiledRelativeDateFilters` CompiledMetricRelativeDateFilter[]
      - `compiledSql` string, required
      - `fieldId` string, required
      - `id` string, required
    - `compiledDistinctKeys` string[]
    - `compiledValueSql` string
    - `compilationError` FieldCompilationError — Error information stored on a field when compilation fails but partial compilation mode is enabled.
      - `message` string, required
    - `tablesAnyAttributes` RecordStringRecordStringStringOrStringArray — Construct a type with a set of properties K of type T
    - `tablesRequiredAttributes` RecordStringRecordStringStringOrStringArray — Construct a type with a set of properties K of type T
    - `tablesReferences` string[]
    - `compiledSql` string, required
  - `status` 'ok', required

## Other responses

- `default` — Error

---

[API](https://skmtc.dev/lightdash/apis/lightdash-api.md) · [All operations](https://skmtc.dev/lightdash/apis/lightdash-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lightdash/lightdash-api/revisions/40c933755c9a/schema)