> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gp.scale.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Evaluation Dashboards

> List dashboards in the caller's account, paginated, with optional filters.

Filter to a single evaluation with `evaluation_id` or to a group with
`evaluation_group_id`; passing both is rejected, since a dashboard is bound to one
or the other. `tags` matches case-insensitively (values are lowercased before
lookup), `created_by_ids` filters by creator identity, and `search` matches the
dashboard name and tags. Archived dashboards are excluded unless `include_archived`
is true. The returned items carry only the dashboards' own fields — widgets and
widget results are never embedded here; use the get-by-id endpoint with the
`widgets`/`widget_results` views to load those.



## OpenAPI

````yaml https://api.dev-sgp.scale.com/openapi-versions/v5/openapi.json get /v5/evaluation-dashboards
openapi: 3.1.0
info:
  title: EGP API V5
  description: >-
    This is the parent API for all EGP APIs. If you are looking for the EGP API,
    please go to https://api.egp.scale.com/docs.
  contact:
    name: Scale Generative AI Platform
    url: https://scale.com/genai-platform
  version: 0.1.0
servers:
  - url: https://api.egp.scale.com
security: []
paths:
  /v5/evaluation-dashboards:
    get:
      tags:
        - Evaluation Dashboards
      summary: List Evaluation Dashboards
      description: >-
        List dashboards in the caller's account, paginated, with optional
        filters.


        Filter to a single evaluation with `evaluation_id` or to a group with

        `evaluation_group_id`; passing both is rejected, since a dashboard is
        bound to one

        or the other. `tags` matches case-insensitively (values are lowercased
        before

        lookup), `created_by_ids` filters by creator identity, and `search`
        matches the

        dashboard name and tags. Archived dashboards are excluded unless
        `include_archived`

        is true. The returned items carry only the dashboards' own fields —
        widgets and

        widget results are never embedded here; use the get-by-id endpoint with
        the

        `widgets`/`widget_results` views to load those.
      operationId: GET-V5-/v5/evaluation-dashboards
      parameters:
        - name: evaluation_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Evaluation Id
        - name: evaluation_group_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Evaluation Group Id
        - name: tags
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            description: Filter by tags (case-insensitive)
            title: Tags
          description: Filter by tags (case-insensitive)
        - name: include_archived
          in: query
          required: false
          schema:
            type: boolean
            default: false
            title: Include Archived
        - name: created_by_ids
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            description: Filter by creator user IDs
            title: Created By Ids
          description: Filter by creator user IDs
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Search in name and tags
            title: Search
          description: Search in name and tags
        - name: starting_after
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Starting After
        - name: ending_before
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Ending Before
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 10000
            minimum: 1
            default: 100
            title: Limit
        - name: sort_by
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Sort By
        - name: sort_order
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/SortOrder'
              - type: 'null'
            default: asc
            title: Sort Order
        - name: x-selected-account-id
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Account ID Header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedList_EvaluationDashboard_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    SortOrder:
      type: string
      enum:
        - asc
        - desc
      title: SortOrder
    PaginatedList_EvaluationDashboard_:
      properties:
        object:
          type: string
          const: list
          title: Object
          default: list
        items:
          items:
            $ref: '#/components/schemas/EvaluationDashboard'
          type: array
          title: Items
        limit:
          type: integer
          title: Limit
          description: The maximum number of items to return.
          default: 100
        total:
          type: integer
          title: Total
          description: >-
            The total of items that match the query. This is greater than or
            equal to the number of items returned.
        has_more:
          type: boolean
          title: Has More
          description: Whether there are more items left to be fetched.
      type: object
      required:
        - items
        - total
        - has_more
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    EvaluationDashboard:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the dashboard
        object:
          type: string
          const: evaluation_dashboard
          title: Object
          default: evaluation_dashboard
        created_by:
          $ref: '#/components/schemas/Identity'
          description: The identity that created the entity.
        tags:
          title: Tags
          description: The tags associated with the entity
          items:
            type: string
          type: array
        name:
          type: string
          title: Name
          description: Dashboard name
        description:
          title: Description
          description: Dashboard description
          type: string
        evaluation_id:
          title: Evaluation Id
          description: Evaluation ID
          type: string
        evaluation_group_id:
          title: Evaluation Group Id
          description: Evaluation group ID
          type: string
        widget_order:
          title: Widget Order
          description: Ordered array of widget IDs
          items:
            type: string
          type: array
        error_message:
          title: Error Message
          description: Error message if computation failed
          type: string
        account_id:
          type: string
          title: Account Id
          description: Account that owns this dashboard
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When the dashboard was created
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: When the dashboard was last updated
        archived_at:
          title: Archived At
          description: When the dashboard was archived (soft-deleted)
          type: string
          format: date-time
        widgets:
          title: Widgets
          description: >-
            Widgets associated with this dashboard. Populated with 'widgets'
            view.
          items:
            $ref: '#/components/schemas/EvaluationDashboardWidget'
          type: array
        widget_results:
          title: Widget Results
          description: >-
            Widget results for this dashboard. Populated with 'widget_results'
            view.
          items:
            $ref: '#/components/schemas/EvaluationDashboardWidgetResult'
          type: array
      type: object
      required:
        - created_by
        - tags
        - id
        - name
        - account_id
        - created_at
        - updated_at
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          title: Error Type
          type: string
        input:
          title: Input
        ctx:
          type: object
          title: Context
          additionalProperties: true
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    Identity:
      properties:
        id:
          type: string
          title: Id
        object:
          type: string
          const: identity
          title: Object
          default: identity
        type:
          $ref: '#/components/schemas/IdentityType'
      type: object
      required:
        - id
        - type
      title: Identity
    EvaluationDashboardWidget:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the widget
        object:
          type: string
          const: evaluation_dashboard_widget
          title: Object
          default: evaluation_dashboard_widget
        title:
          type: string
          title: Title
          description: Widget title
        type:
          $ref: '#/components/schemas/EvaluationWidgetTypeEnum'
          description: Widget type
        query:
          anyOf:
            - $ref: '#/components/schemas/SeriesQuery'
            - $ref: '#/components/schemas/MetricQuery'
          title: Query
          description: >-
            Structured query AST for metric computation (SeriesQuery or
            MetricQuery)
        config:
          title: Config
          description: Chart-specific display configuration
          additionalProperties: true
          type: object
        account_id:
          type: string
          title: Account Id
          description: Account that owns this widget
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When the widget was created
        archived_at:
          title: Archived At
          description: When the widget was archived (soft-deleted)
          type: string
          format: date-time
      type: object
      required:
        - id
        - title
        - type
        - account_id
        - created_at
    EvaluationDashboardWidgetResult:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the widget result
        object:
          type: string
          const: evaluation_dashboard_widget_result
          title: Object
          default: evaluation_dashboard_widget_result
        widget_id:
          type: string
          title: Widget Id
          description: Unique identifier of the widget
        evaluation_id:
          title: Evaluation Id
          description: FK to evaluations. Null if result is for an evaluation group.
          type: string
        evaluation_group_id:
          title: Evaluation Group Id
          description: FK to evaluation_groups. Null if result is for a single evaluation.
          type: string
        computed_result:
          title: Computed Result
          description: Cached computation results
          additionalProperties: true
          type: object
        computation_status:
          $ref: '#/components/schemas/EvaluationWidgetResultStatusEnum'
          description: Status of the computation
        error_message:
          title: Error Message
          description: Error message if computation failed
          type: string
        computation_job_id:
          title: Computation Job Id
          description: Temporal workflow ID or job ID for async computation tracking
          type: string
        computed_at:
          title: Computed At
          description: Timestamp when computation completed successfully
          type: string
          format: date-time
        account_id:
          type: string
          title: Account Id
          description: Account that owns this widget result
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When the widget result was created
        widget:
          $ref: '#/components/schemas/EvaluationDashboardWidget'
          description: Widget that this result is for
      type: object
      required:
        - id
        - widget_id
        - computation_status
        - account_id
        - created_at
    IdentityType:
      type: string
      enum:
        - user
        - service_account
      title: IdentityType
    EvaluationWidgetTypeEnum:
      type: string
      enum:
        - bar
        - histogram
        - donut
        - scatter
        - metric
        - table
        - markdown
        - heading
        - timeseries
      title: EvaluationWidgetTypeEnum
      description: Widget types for dashboard visualizations
    SeriesQuery:
      properties:
        select:
          items:
            $ref: '#/components/schemas/SelectItem'
          type: array
          minItems: 1
          title: Select
        filter:
          $ref: '#/components/schemas/Filter'
          description: Filter conditions (WHERE clause)
        groupBy:
          title: Groupby
          description: Columns to group by
          items:
            type: string
          type: array
        orderBy:
          title: Orderby
          description: Sort order
          items:
            $ref: '#/components/schemas/OrderByColumn'
          type: array
        limit:
          title: Limit
          description: Max rows to return
          type: integer
          minimum: 1
        evaluation_ids:
          title: Evaluation Ids
          description: >-
            Optional subset of evaluation IDs to compute on. Only applicable for
            evaluation group dashboards. If omitted, computes on all evaluations
            in the group.
          items:
            type: string
          type: array
          minItems: 1
        latest_only:
          title: Latest Only
          description: >-
            When True, the widget computes against rows from only the most
            recent active evaluation in the group (by EvaluationORM.created_at).
            Only applicable for evaluation group dashboards. Composes with
            evaluation_ids (latest within the subset). Cannot be combined with
            per-aggregation evaluation_ids; the use case enforces these rules.
          type: boolean
      type: object
      required:
        - select
      title: SeriesQuery
      description: >-
        Query that returns a series of records (used for
        table/bar/histogram/donut/scatter widgets).


        Used for widget types: table, bar, histogram, donut, scatter.

        Returns: {"type": "series", "data": [...]}


        Example SQL equivalent:
            SELECT category, AVG(score) as avg_score, COUNT(*) as count
            FROM evaluation_items
            WHERE score > 0.5 AND category = 'test'
            GROUP BY category
            ORDER BY avg_score DESC
            LIMIT 100
    MetricQuery:
      properties:
        select:
          items:
            $ref: '#/components/schemas/SelectItem'
          type: array
          maxItems: 1
          minItems: 1
          title: Select
        filter:
          $ref: '#/components/schemas/Filter'
          description: Filter conditions (WHERE clause)
        evaluation_ids:
          title: Evaluation Ids
          description: >-
            Optional subset of evaluation IDs to compute on. Only applicable for
            evaluation group dashboards. If omitted, computes on all evaluations
            in the group.
          items:
            type: string
          type: array
          minItems: 1
        latest_only:
          title: Latest Only
          description: >-
            When True, the widget computes against rows from only the most
            recent active evaluation in the group (by EvaluationORM.created_at).
            Only applicable for evaluation group dashboards. Composes with
            evaluation_ids (latest within the subset). Cannot be combined with
            per-aggregation evaluation_ids; the use case enforces these rules.
          type: boolean
      type: object
      required:
        - select
      title: MetricQuery
      description: |-
        Query that returns a single metric value (used for metric widgets).

        Used for widget type: metric.
        Enforces exactly 1 aggregation in select.
        Returns: {"type": "metric", "data": ...}

        Example SQL equivalent:
            SELECT AVG(score) as average_score
            FROM evaluation_items
    EvaluationWidgetResultStatusEnum:
      type: string
      enum:
        - pending
        - completed
        - failed
      title: EvaluationWidgetResultStatusEnum
      description: Status of widget result computation
    SelectItem:
      properties:
        alias:
          title: Alias
          description: Optional alias for the selected item
          type: string
        expression:
          anyOf:
            - $ref: '#/components/schemas/Column'
            - $ref: '#/components/schemas/Aggregation'
          title: Expression
      type: object
      required:
        - expression
      title: SelectItem
      description: Column in SELECT clause
    Filter:
      properties:
        conditions:
          items:
            $ref: '#/components/schemas/FilterCondition'
          type: array
          minItems: 1
          title: Conditions
        logicalOperators:
          title: Logicaloperators
          description: >-
            Logical operators connecting conditions. Length must be
            len(conditions) - 1
          items:
            $ref: '#/components/schemas/LogicalOperatorEnum'
          type: array
      type: object
      required:
        - conditions
      title: Filter
      description: >-
        Filter clause with conditions connected by logical operators.


        Conditions are evaluated left-to-right without precedence (no
        nesting/parentheses).

        Example: condition1 AND condition2 OR condition3 evaluates as
        ((condition1 AND condition2) OR condition3)


        Example:
            {
                "conditions": [
                    {"column": "score", "operator": ">", "value": 0.5},
                    {"column": "category", "operator": "=", "value": "test"}
                ],
                "logicalOperators": ["AND"]
            }
    OrderByColumn:
      properties:
        column:
          type: string
          title: Column
          description: Column name to sort by
        source:
          title: Source
          description: 'Column source: ''data'' or ''task_result_cache'''
          type: string
        direction:
          $ref: '#/components/schemas/SortDirectionEnum'
          description: Sort direction
          default: ASC
      type: object
      required:
        - column
      title: OrderByColumn
      description: Column in ORDER BY clause
    Column:
      properties:
        type:
          type: string
          const: COLUMN
          title: Type
          default: COLUMN
        column:
          type: string
          title: Column
          description: Column name from evaluation_items.data
        source:
          title: Source
          description: 'Column source: ''data'' or ''task_result_cache'''
          type: string
      type: object
      required:
        - column
      title: Column
      description: |-
        Reference to a column from evaluation_items.data

        Example:
            {"type": "COLUMN", "column": "category"}
    Aggregation:
      properties:
        type:
          type: string
          const: AGGREGATION
          title: Type
          default: AGGREGATION
        function:
          $ref: '#/components/schemas/AggregationFunctionEnum'
        column:
          type: string
          title: Column
          description: Column to aggregate, or '*' for COUNT(*)
        source:
          title: Source
          description: 'Column source: ''data'' or ''task_result_cache'''
          type: string
        params:
          title: Params
          description: >-
            Function parameters (e.g., {'percentile': 95} for PERCENTILE,
            {'percentage_filters': Filter} for PERCENTAGE)
          additionalProperties: true
          type: object
        evaluation_ids:
          title: Evaluation Ids
          description: >-
            Optional subset of evaluation IDs for per-aggregation filtering in
            evaluation group dashboards.
          items:
            type: string
          type: array
          minItems: 1
      type: object
      required:
        - function
        - column
      title: Aggregation
      description: |-
        Aggregation function to apply

        Examples:
            {"type": "AGGREGATION", "function": "AVG", "column": "score"}
            {"type": "AGGREGATION", "function": "COUNT", "column": "*"}
            {"type": "AGGREGATION", "function": "PERCENTILE", "column": "score", "params": {"percentile": 95}}
    FilterCondition:
      properties:
        column:
          type: string
          title: Column
          description: Column name to filter on
        source:
          title: Source
          description: 'Column source: ''data'' or ''task_result_cache'''
          type: string
        operator:
          $ref: '#/components/schemas/ComparisonOperatorEnum'
          description: Comparison operator
        value:
          anyOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
            - items: {}
              type: array
          title: Value
          description: >-
            Value to compare against. Not required for IS NULL / IS NOT NULL
            operators.
      type: object
      required:
        - column
        - operator
      title: FilterCondition
      description: |-
        Single filter condition comparing a column to a value.

        Example:
            {"column": "score", "operator": ">", "value": 0.5}
            {"column": "category", "operator": "=", "value": "test"}
    LogicalOperatorEnum:
      type: string
      enum:
        - AND
        - OR
      title: LogicalOperatorEnum
      description: Logical operators for connecting filter conditions
    SortDirectionEnum:
      type: string
      enum:
        - ASC
        - DESC
      title: SortDirectionEnum
      description: Sort directions
    AggregationFunctionEnum:
      type: string
      enum:
        - COUNT
        - SUM
        - AVG
        - MIN
        - MAX
        - STDDEV
        - VARIANCE
        - PERCENTILE
        - COUNT_DISTINCT
        - PERCENTAGE
      title: AggregationFunctionEnum
      description: Supported aggregation functions
    ComparisonOperatorEnum:
      type: string
      enum:
        - '='
        - '!='
        - '>'
        - <
        - '>='
        - <=
        - IN
        - NOT IN
        - LIKE
        - NOT LIKE
        - IS NULL
        - IS NOT NULL
      title: ComparisonOperatorEnum
      description: Supported comparison operators for filtering
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````