Select Star metrics API

openapi: 3.0.3
info:
  title: Select Star Metadata bi metrics API
  version: 1.0.0
  x-role-system:
    description: This API uses role-based access control
    roles:
      admin: Full access to all operations
      data_manager: Can modify data and configurations
      user: Read-only access to most resources
  description: API for interacting with the Select Star system
  termsOfService: https://www.selectstar.com/terms-of-service
  contact:
    email: support@selectstar.com
  license:
    name: All Rights Reserved
tags:
- name: metrics
paths:
  /v1/metrics/:
    get:
      operationId: metrics_list
      description: 'List of all metrics available in authenticated user''s organization


        **Required Role:** Viewer or higher'
      parameters:
      - name: collections
        required: false
        in: query
        description: A comma separated list of collection guids, for to filter the collection items from
        schema:
          type: string
          pattern: ^(cn)_(?P<guid>[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22})$
      - name: dimensions
        required: false
        in: query
        description: A comma separated list of dimension guids to filter for metrics with those dimensions
        schema:
          type: string
      - name: no_tags
        required: false
        in: query
        description: A flag that filters out any tagged tables
        schema:
          type: string
      - name: order
        required: false
        in: query
        description: "Specify the ordering for the results. \n\n A comma separated list for ordering by multiple fields and a preceding `-` indicates reverse order. \n\nNote: Order is case-sensitive."
        schema:
          type: string
          enum:
          - collection
          - description
          - name
          - popularity
          - sql
          - synonyms
      - name: owners
        required: false
        in: query
        description: A comma separated list of user or team guids to filter for objects within these users as owners (technical or business).
        schema:
          type: string
          pattern: ^(us|te)_(?P<guid>[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22})$
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search_collections
        required: false
        in: query
        description: Search for an asset using a collection name
        schema:
          type: string
      - name: search_description
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - name: search_name
        required: false
        in: query
        description: Search for an asset using its name
        schema:
          type: string
      - name: search_sql
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - name: search_synonyms
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - name: search_tag_name
        required: false
        in: query
        description: Search for an asset using a tag name
        schema:
          type: string
      - name: semantic_models
        required: false
        in: query
        description: Filter by one or more semantic model GUIDs. Provide a comma-separated list of GUIDs.
        schema:
          type: string
          pattern: ^(sm)_(?P<guid>[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22})$
      - name: status_tags
        required: false
        in: query
        description: A comma separated list of tag guids
        schema:
          type: string
          pattern: ^(tg)_(?P<guid>[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22})$
      - name: teams
        required: false
        in: query
        description: A comma separated list of team guids to filter for tables owned by users of those teams.
        schema:
          type: string
          pattern: ^(te)_(?P<guid>[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22})$
      tags:
      - metrics
      security:
      - JWTAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedMetricList'
          description: ''
      x-role-requirements: Viewer or higher
    post:
      operationId: metrics_create
      description: 'Create a metric within authenticated user''s organization


        **Required Role:** Data Manager or higher'
      tags:
      - metrics
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MetricCreateRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/MetricCreateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/MetricCreateRequest'
      security:
      - JWTAuthentication: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricCreate'
          description: ''
      x-role-requirements: Data Manager or higher
  /v1/metrics/{guid}/:
    get:
      operationId: metrics_retrieve
      description: 'Retrieve a single metric


        **Required Role:** Viewer or higher'
      parameters:
      - in: path
        name: guid
        schema:
          type: string
          pattern: ^([a-zA-z]{2}_[a-zA-Z0-9]{22})|me|default|([a-zA-z]{2}_[a-zA-Z0-9]{22}).personal$
        required: true
      tags:
      - metrics
      security:
      - JWTAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metric'
          description: ''
      x-role-requirements: Viewer or higher
    patch:
      operationId: metrics_partial_update
      description: 'Update a single metric


        **Required Role:** Data Manager or higher'
      parameters:
      - in: path
        name: guid
        schema:
          type: string
          pattern: ^([a-zA-z]{2}_[a-zA-Z0-9]{22})|me|default|([a-zA-z]{2}_[a-zA-Z0-9]{22}).personal$
        required: true
      tags:
      - metrics
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedMetricRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedMetricRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedMetricRequest'
      security:
      - JWTAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metric'
          description: ''
      x-role-requirements: Data Manager or higher
    delete:
      operationId: metrics_destroy
      description: 'Archive a single metric


        **Required Role:** Data Manager or higher'
      parameters:
      - name: collections
        required: false
        in: query
        description: A comma separated list of collection guids, for to filter the collection items from
        schema:
          type: string
          pattern: ^(cn)_(?P<guid>[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22})$
      - name: dimensions
        required: false
        in: query
        description: A comma separated list of dimension guids to filter for metrics with those dimensions
        schema:
          type: string
      - in: path
        name: guid
        schema:
          type: string
          pattern: ^([a-zA-z]{2}_[a-zA-Z0-9]{22})|me|default|([a-zA-z]{2}_[a-zA-Z0-9]{22}).personal$
        required: true
      - name: no_tags
        required: false
        in: query
        description: A flag that filters out any tagged tables
        schema:
          type: string
      - name: order
        required: false
        in: query
        description: "Specify the ordering for the results. \n\n A comma separated list for ordering by multiple fields and a preceding `-` indicates reverse order. \n\nNote: Order is case-sensitive."
        schema:
          type: string
          enum:
          - collection
          - description
          - name
          - popularity
          - sql
          - synonyms
      - name: owners
        required: false
        in: query
        description: A comma separated list of user or team guids to filter for objects within these users as owners (technical or business).
        schema:
          type: string
          pattern: ^(us|te)_(?P<guid>[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22})$
      - name: search_collections
        required: false
        in: query
        description: Search for an asset using a collection name
        schema:
          type: string
      - name: search_description
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - name: search_name
        required: false
        in: query
        description: Search for an asset using its name
        schema:
          type: string
      - name: search_sql
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - name: search_synonyms
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - name: search_tag_name
        required: false
        in: query
        description: Search for an asset using a tag name
        schema:
          type: string
      - name: semantic_models
        required: false
        in: query
        description: Filter by one or more semantic model GUIDs. Provide a comma-separated list of GUIDs.
        schema:
          type: string
          pattern: ^(sm)_(?P<guid>[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22})$
      - name: status_tags
        required: false
        in: query
        description: A comma separated list of tag guids
        schema:
          type: string
          pattern: ^(tg)_(?P<guid>[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22})$
      - name: teams
        required: false
        in: query
        description: A comma separated list of team guids to filter for tables owned by users of those teams.
        schema:
          type: string
          pattern: ^(te)_(?P<guid>[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22})$
      tags:
      - metrics
      security:
      - JWTAuthentication: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      x-role-requirements: Data Manager or higher
  /v1/metrics/dimensions/:
    patch:
      operationId: metrics_dimensions_partial_update
      description: 'Update a single metric''s dimensions


        **Required Role:** Data Manager or higher'
      tags:
      - metrics
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedDimensionRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedDimensionRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedDimensionRequest'
      security:
      - JWTAuthentication: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dimension'
          description: ''
      x-role-requirements: Data Manager or higher
components:
  schemas:
    TypeB32Enum:
      enum:
      - status
      - dbt
      type: string
      description: '* `status` - status

        * `dbt` - dbt'
    BaseDataSource:
      type: object
      properties:
        guid:
          type: string
          maxLength: 25
        type:
          $ref: '#/components/schemas/Type6b6Enum'
        name:
          type: string
          maxLength: 100
      required:
      - name
      - type
    PaginatedMetricList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/Metric'
    DimensionSerializer.GuidReferenceField.fieldRequest:
      type: string
      description: GUID
    LookMLView:
      type: object
      description: 'Adds support for reading a description from metadata

        that support modifying description'
      properties:
        guid:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
          description: Fully-qualified name of the field
        label:
          type: string
          readOnly: true
          description: Fully-qualified human-readable label of the field
        project_name:
          type: string
          readOnly: true
          nullable: true
          description: Name of project containing the view
        data_source:
          allOf:
          - $ref: '#/components/schemas/DataSourceInfo'
          readOnly: true
        external_id:
          type: string
          readOnly: true
          description: External unique identifier of this resource
        breadcrumbs:
          type: array
          items:
            $ref: '#/components/schemas/Breadcrumb'
          readOnly: true
        tagged_items:
          type: array
          items:
            $ref: '#/components/schemas/TaggedItemsLiteWithSource'
          readOnly: true
        description:
          type: string
          nullable: true
          description: Active description
        description_source:
          allOf:
          - $ref: '#/components/schemas/DescriptionSourceEnum'
          readOnly: true
          nullable: true
        user_description:
          type: string
          readOnly: true
          nullable: true
          description: User description
        user_description_author:
          allOf:
          - $ref: '#/components/schemas/UserLite'
          readOnly: true
        ai_description:
          type: string
          readOnly: true
          nullable: true
          description: AI-generated description
        ingested_description:
          type: string
          readOnly: true
          nullable: true
          description: Unmodified description from the data source
        richtext_description:
          type: string
          nullable: true
          description: Richtext formatted description. Can be in Slatejs or Draftjs format.
        explores:
          type: array
          items:
            $ref: '#/components/schemas/ExploreLabel'
          readOnly: true
        business_owner:
          $ref: '#/components/schemas/LookMLViewSerializer.GuidReferenceField.business_owner'
        technical_owner:
          $ref: '#/components/schemas/LookMLViewSerializer.GuidReferenceField.technical_owner'
        popularity:
          allOf:
          - $ref: '#/components/schemas/LookerViewPopularity'
          readOnly: true
        search_name:
          type: string
          readOnly: true
        downstream_objects_counts:
          allOf:
          - $ref: '#/components/schemas/RelatedObjectsCounts'
          readOnly: true
        upstream_objects_counts:
          allOf:
          - $ref: '#/components/schemas/RelatedObjectsCounts'
          readOnly: true
        data_types:
          allOf:
          - $ref: '#/components/schemas/BaseType'
          readOnly: true
        collections:
          type: array
          items:
            $ref: '#/components/schemas/CollectionLite'
          readOnly: true
      required:
      - ai_description
      - breadcrumbs
      - collections
      - data_source
      - data_types
      - description_source
      - downstream_objects_counts
      - explores
      - external_id
      - guid
      - ingested_description
      - label
      - name
      - popularity
      - project_name
      - search_name
      - tagged_items
      - upstream_objects_counts
      - user_description
      - user_description_author
    LookMLFieldFieldTypeEnum:
      enum:
      - measure
      - dimension
      - field_set
      type: string
      description: '* `measure` - measure

        * `dimension` - dimension

        * `field_set` - field_set'
    BaseMetadata:
      type: object
      properties:
        object_type:
          type: string
          readOnly: true
        guid:
          type: string
          readOnly: true
        name:
          type: string
          nullable: true
          readOnly: true
        breadcrumbs:
          type: array
          items:
            $ref: '#/components/schemas/Breadcrumb'
          readOnly: true
      required:
      - breadcrumbs
      - guid
      - name
      - object_type
    Dimension:
      type: object
      properties:
        field:
          $ref: '#/components/schemas/DimensionSerializer.GuidReferenceField.field'
      required:
      - field
    MetricRepresentatedAsSerializer.GuidReferenceField.item:
      anyOf:
      - $ref: '#/components/schemas/BaseMetadata'
      - $ref: '#/components/schemas/ExploreFieldMetric'
      discriminator:
        propertyName: object_type
        mapping:
          bicolumn: '#/components/schemas/BaseMetadata'
          column: '#/components/schemas/BaseMetadata'
          explorefield: '#/components/schemas/ExploreFieldMetric'
          lookmlfield: '#/components/schemas/BaseMetadata'
          metabasetable: '#/components/schemas/BaseMetadata'
          powerbicolumn: '#/components/schemas/BaseMetadata'
          powerbidataset: '#/components/schemas/BaseMetadata'
          tableaudatasource: '#/components/schemas/BaseMetadata'
          tableaufield: '#/components/schemas/BaseMetadata'
          thoughtspotcolumn: '#/components/schemas/BaseMetadata'
    Breadcrumb:
      type: object
      properties:
        guid:
          type: string
          maxLength: 25
        target_guid:
          type: string
          maxLength: 256
        target_name:
          type: string
          readOnly: true
        target_object_type:
          type: string
        target_data_type:
          type: string
        target_data_source_guid:
          type: string
          nullable: true
          readOnly: true
        target_data_source_type:
          allOf:
          - $ref: '#/components/schemas/TargetDataSourceTypeEnum'
          nullable: true
        ordinal:
          type: integer
          maximum: 2147483647
          minimum: 0
          description: Ordering of breadcrumb within the table
      required:
      - target_data_source_guid
      - target_data_type
      - target_guid
      - target_name
      - target_object_type
    TaggedItemsLite:
      type: object
      description: Serializer without suggestion source
      properties:
        item:
          $ref: '#/components/schemas/TaggedItemsLiteSerializer.GuidReferenceField.item'
        guid:
          type: string
          readOnly: true
        tag:
          $ref: '#/components/schemas/TagLite'
        kind:
          type: string
        suggested_source_kind:
          type: string
      required:
      - guid
      - item
      - kind
      - suggested_source_kind
      - tag
    SuggestedDescriptionSourceEnum:
      enum:
      - public_docs
      - lineage
      - downstream_lineage
      - upstream_lineage
      - similarity
      - unknown
      type: string
      description: '* `public_docs` - Public Docs

        * `lineage` - Lineage

        * `downstream_lineage` - Downstream Lineage

        * `upstream_lineage` - Upstream Lineage

        * `similarity` - Similarity

        * `unknown` - Unknown'
    MetricRepresentatedAs:
      type: object
      properties:
        item:
          $ref: '#/components/schemas/MetricRepresentatedAsSerializer.GuidReferenceField.item'
        parent:
          $ref: '#/components/schemas/MetricRepresentatedAsSerializer.GuidReferenceField.parent'
        full_name:
          type: string
          description: Full name of the metric view
        full_sql:
          type: string
          description: Full SQL of the metric view
        additional_condition:
          type: string
          description: Additional condition applied to the base metric
      required:
      - item
      - parent
    MetricCreate:
      type: object
      properties:
        guid:
          type: string
          maxLength: 25
        name:
          type: string
          maxLength: 255
        data_type:
          type: string
          readOnly: true
        description:
          type: string
          nullable: true
          description: Active description
        richtext_description:
          type: string
          nullable: true
          description: Richtext formatted description. Can be in Slatejs or Draftjs format.
        created_by:
          allOf:
          - $ref: '#/components/schemas/User'
          readOnly: true
        dimensions:
          type: array
          items:
            $ref: '#/components/schemas/Dimension'
        business_owner:
          $ref: '#/components/schemas/MetricCreateSerializer.GuidReferenceField.business_owner'
        technical_owner:
          $ref: '#/components/schemas/MetricCreateSerializer.GuidReferenceField.technical_owner'
        represented_as:
          type: string
          description: The plaintext Metric represented as formula
        richtext_represented_as:
          type: string
          nullable: true
          description: The richtext enabled Metric represented as formula
        updated_on:
          type: string
          format: date-time
          readOnly: true
        sql:
          type: string
          nullable: true
          description: The SQL that represents the calculation of this metric
        synonyms:
          type: array
          items:
            type: string
            maxLength: 255
          description: Array of synonyms/alternative names for this metric
        tagged_items:
          type: array
          items:
            $ref: '#/components/schemas/TaggedItemsLiteWithSource'
          readOnly: true
        ordinal:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
          description: Ordinal number for determining sorting order of that document
        parent_hierarchy:
          type: string
          readOnly: true
        full_path:
          type: string
          readOnly: true
        breadcrumbs:
          type: array
          items:
            $ref: '#/components/schemas/Breadcrumb'
          readOnly: true
        represented_as_fields:
          type: array
          items:
            $ref: '#/components/schemas/MetricRepresentatedAs'
          readOnly: true
        data_types:
          allOf:
          - $ref: '#/components/schemas/BaseType'
          readOnly: true
        collections:
          type: array
          items:
            $ref: '#/components/schemas/CollectionLite'
          readOnly: true
      required:
      - breadcrumbs
      - collections
      - created_by
      - data_type
      - data_types
      - full_path
      - parent_hierarchy
      - represented_as_fields
      - tagged_items
      - updated_on
    DescriptionSourceEnum:
      enum:
      - user
      - ingestion
      - ai
      - public_docs
      - lineage
      - downstream_lineage
      - upstream_lineage
      - similarity
      - unknown
      type: string
      description: '* `user` - User

        * `ingestion` - Ingestion

        * `ai` - Ai

        * `public_docs` - Public Docs

        * `lineage` - Lineage

        * `downstream_lineage` - Downstream Lineage

        * `upstream_lineage` - Upstream Lineage

        * `similarity` - Similarity

        * `unknown` - Unknown'
    UserSetting:
      type: object
      properties:
        enable_email_notifications:
          type: boolean
          description: Whether this user wants an email notification or not
        enable_slack_notifications:
          type: boolean
          description: Whether this user wants a slack notification or not
        enable_notifications_for_schema_changes:
          type: boolean
          description: Whether this user wants a slack notification for schema changes or not
        enable_notifications_for_metadata_changes:
          type: boolean
          description: Whether this user wants a slack notification for metadata changes or not
        enable_discussions_notifications:
          type: boolean
          description: Whether this user wants a notification for new discussions or not
        enable_favorites_notifications_for_schema_changes:
          type: boolean
          description: Whether this user wants a schema change notification for favorited items or not
        enable_favorites_notifications_for_metadata_changes:
          type: boolean
          description: Whether this user wants a metadata change notification for favorited items or not
        enable_favorites_notifications_for_discussions:
          type: boolean
          description: Whether this user wants a discussion notification for favorited items or not
        default_database_table_column_order:
          allOf:
          - $ref: '#/components/schemas/DefaultDatabaseTableColumnOrderEnum'
          description: 'Database table column order. There are several different ways to order columns


            * `popularity` - popularity

            * `column_ordinal_position` - column_ordinal_position

            * `alphabetical` - alphabetical'
        default_table_dashboard_tab:
          allOf:
          - $ref: '#/components/schemas/DefaultTableDashboardTabEnum'
          description: 'Default tab for table / dashboard page


            * `overview` - overview

            * `columns_charts` - columns_charts'
    PatchedDimensionRequest:
      type: object
      properties:
        field:
          $ref: '#/components/schemas/DimensionSerializer.GuidReferenceField.fieldRequest'
    MetricCreateSerializer.GuidReferenceField.business_ownerRequest:
      type: string
      description: GUID
    LookerExploreFieldPopularity:
      type: object
      properties:
        timeframe:
          type: integer
          readOnly: true
          default: 90
        user_count:
          type: integer
          readOnly: true
        service_query_count:
          type: integer
          readOnly: true
        popularity:
          type: integer
          readOnly: true
          description: Popularity score for this object from 0-100
        query_count:
          type: integer
      required:
      - popularity
      - query_count
      - service_query_count
      - timeframe
      - user_count
    DimensionSerializer.GuidReferenceField.field:
      anyOf:
      - $ref: '#/components/schemas/ExploreField'
      - $ref: '#/components/schemas/MetadataSerializerWithPopularity'
      discriminator:
        propertyName: object_type
        mapping:
          bicolumn: '#/components/schemas/MetadataSerializerWithPopularity'
          column: '#/components/schemas/MetadataSerializerWithPopularity'
          explorefield: '#/components/schemas/ExploreField'
          lookmlfield: '#/components/schemas/MetadataSerializerWithPopularity'
          powerbicolumn: '#/components/schemas/MetadataSerializerWithPopularity'
          tableaufield: '#/components/schemas/MetadataSerializerWithPopularity'
          thoughtspotcolumn: '#/components/schemas/MetadataSerializerWithPopularity'
    Metric:
      type: object
      properties:
        guid:
          type: string
          readOnly: true
        name:
          type: string
        data_type:
          type: string
          readOnly: true
        description:
          type: string
          nullable: true
          description: Active description
        richtext_description:
          type: string
          nullable: true
          description: Richtext formatted description. Can be in Slatejs or Draftjs format.
        created_by:
          allOf:
          - $ref: '#/components/schemas/User'
          readOnly: true
        dimensions:
          type: array
          items:
            $ref: '#/components/schemas/Dimension'
        business_owner:
          $ref: '#/components/schemas/MetricSerializer.GuidReferenceField.business_owner'
        technical_owner:
          $ref: '#/components/schemas/MetricSerializer.GuidReferenceField.technical_owner'
        represented_as:
          type: string
          description: The plaintext Metric represented as formula
        richtext_represented_as:
          type: string
          nullable: true
          description: The richtext enabled Metric represented as formula
        updated_on:
          type: string
          format: date-time
          readOnly: true
        sql:
          type: string
          nullable: true
          description: The SQL that represents the calculation of this metric
        synonyms:
          type: array
          items:
            type: string
            maxLength: 255
          description: Array of synonyms/alternative names for this metric
        tagged_items:
          type: array
          items:
            $ref: '#/components/schemas/TaggedItemsLiteWithSource'
          readOnly: true
        ordinal:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
          description: Ordinal number for determining sorting order of that document
        parent_hierarchy:
          type: string
          readOnly: true
        full_path:
          type: string
          readOnly: true
        breadcrumbs:
          type: array
          items:
            $ref: '#/components/schemas/Breadcrumb'
          readOnly: true
        represented_as_fields:
          type: array
          items:
            $ref: '#/components/schemas/MetricRepresentatedAs'
          readOnly: true
        data_types:
          allOf:
          - $ref: '#/components/schemas/BaseType'
          readOnly: true
        collections:
          type: array
          items:
            $ref: '#/components/schemas/CollectionLite'
          readOnly: true
      required:
      - breadcrumbs
      - collections
      - created_by
      - data_type
      - data_types
      - full_path
      - guid
      - parent_hierarchy
      - represented_as_fields
      - tagged_items
      - updated_on
    MetricCreateRequest:
      type: object
      properties:
        guid:
          type: string
          minLength: 1
          maxLength: 25
        name:
          type: string
          maxLength: 255
        description:
          type: string
          nullable: true
          description: Active description
        richtext_description:
          type: string
          nullable: true
          description: Richtext formatted description. Can be in Slatejs or Draftjs format.
        dimensions:
          type: array
          items:
            $ref: '#/components/schemas/DimensionRequest'
        business_owner:
          $ref: '#/components/schemas/MetricCreateSerializer.GuidReferenceField.business_ownerRequest'
        technical_owner:
          $ref: '#/components/schemas/MetricCreateSerializer.GuidReferenceField.technical_ownerRequest'
        represented_as:
          type: string
          description: The plaintext Metric represented as formula
        richtext_represented_as:
          type: string
          nullable: true
          description: The richtext enabled Metric represented as formula
        sql:
          type: string
          nullable: true
          description: The SQL that 

# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/select-star/refs/heads/main/openapi/select-star-metrics-api-openapi.yml