Galileo Technologies custom_dashboards API
The custom_dashboards API from Galileo Technologies — 8 operation(s) for custom_dashboards.
The custom_dashboards API from Galileo Technologies — 8 operation(s) for custom_dashboards.
openapi: 3.1.0
info:
title: Galileo API Server annotation custom_dashboards API
version: 1.1085.0
servers:
- url: https://api.galileo.ai
description: Galileo API Server - galileo-v2
tags:
- name: custom_dashboards
paths:
/custom_dashboards:
get:
tags:
- custom_dashboards
summary: List Dashboards
operationId: list_dashboards_custom_dashboards_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/CustomDashboardResponse'
type: array
title: Response List Dashboards Custom Dashboards Get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
post:
tags:
- custom_dashboards
summary: Create Dashboard
operationId: create_dashboard_custom_dashboards_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CustomDashboardCreateRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CustomDashboardResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
/custom_dashboards/metric_columns:
get:
tags:
- custom_dashboards
summary: Get Metric Columns
description: Return all org scorer columns in LogRecordsColumnInfo format.
operationId: get_metric_columns_custom_dashboards_metric_columns_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LogRecordsAvailableColumnsResponse'
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
/custom_dashboards/{dashboard_id}:
get:
tags:
- custom_dashboards
summary: Get Dashboard
operationId: get_dashboard_custom_dashboards__dashboard_id__get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: dashboard_id
in: path
required: true
schema:
type: string
format: uuid4
title: Dashboard Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CustomDashboardResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- custom_dashboards
summary: Update Dashboard
operationId: update_dashboard_custom_dashboards__dashboard_id__put
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: dashboard_id
in: path
required: true
schema:
type: string
format: uuid4
title: Dashboard Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomDashboardUpdateRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CustomDashboardResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- custom_dashboards
summary: Delete Dashboard
operationId: delete_dashboard_custom_dashboards__dashboard_id__delete
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: dashboard_id
in: path
required: true
schema:
type: string
format: uuid4
title: Dashboard Id
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/custom_dashboards/{dashboard_id}/favorite:
put:
tags:
- custom_dashboards
summary: Favorite Dashboard
operationId: favorite_dashboard_custom_dashboards__dashboard_id__favorite_put
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: dashboard_id
in: path
required: true
schema:
type: string
format: uuid4
title: Dashboard Id
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- custom_dashboards
summary: Unfavorite Dashboard
operationId: unfavorite_dashboard_custom_dashboards__dashboard_id__favorite_delete
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: dashboard_id
in: path
required: true
schema:
type: string
format: uuid4
title: Dashboard Id
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/custom_dashboards/{dashboard_id}/widgets:
post:
tags:
- custom_dashboards
summary: Create Widget
operationId: create_widget_custom_dashboards__dashboard_id__widgets_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: dashboard_id
in: path
required: true
schema:
type: string
format: uuid4
title: Dashboard Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomDashboardWidgetCreateRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CustomDashboardWidgetResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/custom_dashboards/{dashboard_id}/widgets/{widget_id}:
put:
tags:
- custom_dashboards
summary: Update Widget
operationId: update_widget_custom_dashboards__dashboard_id__widgets__widget_id__put
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: dashboard_id
in: path
required: true
schema:
type: string
format: uuid4
title: Dashboard Id
- name: widget_id
in: path
required: true
schema:
type: string
format: uuid4
title: Widget Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomDashboardWidgetUpdateRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CustomDashboardWidgetResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- custom_dashboards
summary: Delete Widget
operationId: delete_widget_custom_dashboards__dashboard_id__widgets__widget_id__delete
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: dashboard_id
in: path
required: true
schema:
type: string
format: uuid4
title: Dashboard Id
- name: widget_id
in: path
required: true
schema:
type: string
format: uuid4
title: Widget Id
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/custom_dashboards/{dashboard_id}/sections:
post:
tags:
- custom_dashboards
summary: Create Section
operationId: create_section_custom_dashboards__dashboard_id__sections_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: dashboard_id
in: path
required: true
schema:
type: string
format: uuid4
title: Dashboard Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomDashboardSectionCreateRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CustomDashboardSectionResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/custom_dashboards/{dashboard_id}/sections/{section_id}:
put:
tags:
- custom_dashboards
summary: Update Section
operationId: update_section_custom_dashboards__dashboard_id__sections__section_id__put
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: dashboard_id
in: path
required: true
schema:
type: string
format: uuid4
title: Dashboard Id
- name: section_id
in: path
required: true
schema:
type: string
format: uuid4
title: Section Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomDashboardSectionUpdateRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CustomDashboardSectionResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- custom_dashboards
summary: Delete Section
description: Delete section. If ungroup=True, keep widgets by moving them to dashboard top-level.
operationId: delete_section_custom_dashboards__dashboard_id__sections__section_id__delete
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: dashboard_id
in: path
required: true
schema:
type: string
format: uuid4
title: Dashboard Id
- name: section_id
in: path
required: true
schema:
type: string
format: uuid4
title: Section Id
- name: ungroup
in: query
required: false
schema:
type: boolean
default: false
title: Ungroup
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
MetricThreshold:
properties:
inverted:
type: boolean
title: Inverted
description: Whether the column should be inverted for thresholds, i.e. if True, lower is better.
default: false
buckets:
items:
anyOf:
- type: integer
- type: number
type: array
title: Buckets
description: Threshold buckets for the column. If the column is a metric, these are the thresholds for the column.
display_value_levels:
items:
type: string
type: array
title: Display Value Levels
description: Ordered list of strings that raw values get transformed to for displaying.
type: object
title: MetricThreshold
description: 'Threshold configuration for metrics.
Defines how metric values are bucketed and displayed, including whether
lower or higher values are considered better.'
? NotNode_Annotated_Union_LogRecordsIDFilter__LogRecordsDateFilter__LogRecordsNumberFilter__LogRecordsBooleanFilter__LogRecordsCollectionFilter__LogRecordsTextFilter__LogRecordsFullyAnnotatedFilter___FieldInfo_annotation_NoneType__required_True__discriminator__type____-Input
: properties:
not:
anyOf:
- $ref: '#/components/schemas/FilterLeaf_Annotated_Union_LogRecordsIDFilter__LogRecordsDateFilter__LogRecordsNumberFilter__LogRecordsBooleanFilter__LogRecordsCollectionFilter__LogRecordsTextFilter__LogRecordsFullyAnnotatedFilter___FieldInfo_annotation_NoneType__required_True__discriminator__type____'
- $ref: '#/components/schemas/AndNode_Annotated_Union_LogRecordsIDFilter__LogRecordsDateFilter__LogRecordsNumberFilter__LogRecordsBooleanFilter__LogRecordsCollectionFilter__LogRecordsTextFilter__LogRecordsFullyAnnotatedFilter___FieldInfo_annotation_NoneType__required_True__discriminator__type____-Input'
- $ref: '#/components/schemas/OrNode_Annotated_Union_LogRecordsIDFilter__LogRecordsDateFilter__LogRecordsNumberFilter__LogRecordsBooleanFilter__LogRecordsCollectionFilter__LogRecordsTextFilter__LogRecordsFullyAnnotatedFilter___FieldInfo_annotation_NoneType__required_True__discriminator__type____-Input'
- $ref: '#/components/schemas/NotNode_Annotated_Union_LogRecordsIDFilter__LogRecordsDateFilter__LogRecordsNumberFilter__LogRecordsBooleanFilter__LogRecordsCollectionFilter__LogRecordsTextFilter__LogRecordsFullyAnnotatedFilter___FieldInfo_annotation_NoneType__required_True__discriminator__type____-Input'
title: Not
type: object
required:
- not
title: NotNode[Annotated[Union[LogRecordsIDFilter, LogRecordsDateFilter, LogRecordsNumberFilter, LogRecordsBooleanFilter, LogRecordsCollectionFilter, LogRecordsTextFilter, LogRecordsFullyAnnotatedFilter], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]
CustomDashboardWidgetCreateRequest:
properties:
name:
type: string
maxLength: 100
minLength: 1
title: Name
description:
anyOf:
- type: string
maxLength: 500
- type: 'null'
title: Description
type:
$ref: '#/components/schemas/WidgetType'
dataset:
anyOf:
- items:
additionalProperties:
items:
type: string
type: array
type: object
type: array
maxItems: 50
- type: 'null'
title: Dataset
metric:
type: string
minLength: 1
title: Metric
aggregation:
$ref: '#/components/schemas/MetricAggregation'
section_id:
anyOf:
- type: string
format: uuid4
- type: 'null'
title: Section Id
analysis_mode:
anyOf:
- $ref: '#/components/schemas/AnalysisMode'
- type: 'null'
type: object
required:
- name
- type
- metric
- aggregation
title: CustomDashboardWidgetCreateRequest
description: Request to create a widget on a custom dashboard.
InputTypeEnum:
type: string
enum:
- basic
- llm_spans
- retriever_spans
- sessions_normalized
- sessions_trace_io_only
- tool_spans
- trace_input_only
- trace_io_only
- trace_normalized
- trace_output_only
- agent_spans
- workflow_spans
title: InputTypeEnum
description: Enumeration of input types.
? FilterLeaf_Annotated_Union_LogRecordsIDFilter__LogRecordsDateFilter__LogRecordsNumberFilter__LogRecordsBooleanFilter__LogRecordsCollectionFilter__LogRecordsTextFilter__LogRecordsFullyAnnotatedFilter___FieldInfo_annotation_NoneType__required_True__discriminator__type____
: properties:
filter:
oneOf:
- $ref: '#/components/schemas/LogRecordsIDFilter'
- $ref: '#/components/schemas/LogRecordsDateFilter'
- $ref: '#/components/schemas/LogRecordsNumberFilter'
- $ref: '#/components/schemas/LogRecordsBooleanFilter'
- $ref: '#/components/schemas/LogRecordsCollectionFilter'
- $ref: '#/components/schemas/LogRecordsTextFilter'
- $ref: '#/components/schemas/LogRecordsFullyAnnotatedFilter'
title: Filter
discriminator:
propertyName: type
mapping:
boolean: '#/components/schemas/LogRecordsBooleanFilter'
collection: '#/components/schemas/LogRecordsCollectionFilter'
date: '#/components/schemas/LogRecordsDateFilter'
fully_annotated: '#/components/schemas/LogRecordsFullyAnnotatedFilter'
id: '#/components/schemas/LogRecordsIDFilter'
number: '#/components/schemas/LogRecordsNumberFilter'
text: '#/components/schemas/LogRecordsTextFilter'
type: object
required:
- filter
title: FilterLeaf[Annotated[Union[LogRecordsIDFilter, LogRecordsDateFilter, LogRecordsNumberFilter, LogRecordsBooleanFilter, LogRecordsCollectionFilter, LogRecordsTextFilter, LogRecordsFullyAnnotatedFilter], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]
LogRecordsCollectionFilter:
properties:
column_id:
type: string
title: Column Id
description: ID of the column to filter.
operator:
type: string
enum:
- eq
- contains
- one_of
- not_in
title: Operator
value:
anyOf:
- type: string
- items:
type: string
type: array
title: Value
case_sensitive:
type: boolean
title: Case Sensitive
default: true
type:
type: string
const: collection
title: Type
default: collection
type: object
required:
- column_id
- operator
- value
title: LogRecordsCollectionFilter
BaseGeneratedScorerDB:
properties:
id:
type: string
format: uuid4
title: Id
name:
type: string
title: Name
instructions:
anyOf:
- type: string
- type: 'null'
title: Instructions
chain_poll_template:
$ref: '#/components/schemas/ChainPollTemplate'
user_prompt:
anyOf:
- type: string
- type: 'null'
title: User Prompt
type: object
required:
- id
- name
- chain_poll_template
title: BaseGeneratedScorerDB
BaseScorerVersionDB:
properties:
id:
type: string
format: uuid4
title: Id
version:
type: integer
title: Version
scorer_id:
type: string
format: uuid4
title: Scorer Id
generated_scorer:
anyOf:
- $ref: '#/components/schemas/BaseGeneratedScorerDB'
- type: 'null'
registered_scorer:
anyOf:
- $ref: '#/components/schemas/BaseRegisteredScorerDB'
- type: 'null'
finetuned_scorer:
anyOf:
- $ref: '#/components/schemas/BaseFinetunedScorerDB'
- type: 'null'
model_name:
anyOf:
- type: string
- type: 'null'
title: Model Name
num_judges:
anyOf:
- type: integer
- type: 'null'
title: Num Judges
scoreable_node_types:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Scoreable Node Types
description: List of node types that can be scored by this scorer. Defaults to llm/chat.
cot_enabled:
anyOf:
- type: boolean
- type: 'null'
title: Cot Enabled
description: Whether to enable chain of thought for this scorer. Defaults to False for llm scorers.
output_type:
anyOf:
- $ref: '#/components/schemas/OutputTypeEnum'
- type: 'null'
description: What type of output to use for model-based scorers (sessions_normalized, trace_io_only, etc.).
input_type:
anyOf:
- $ref: '#/components/schemas/InputTypeEnum'
- type: 'null'
description: What type of input to use for model-based scorers (sessions_normalized, trace_io_only, etc.).
type: object
required:
- id
- version
- scorer_id
title: BaseScorerVersionDB
description: Scorer version from the scorer_versions table.
OutputTypeEnum:
type: string
enum:
- boolean
- categorical
- count
- discrete
- freeform
- percentage
- multilabel
- retrieved_chunk_list_boolean
- boolean_multilabel
title: OutputTypeEnum
description: Enumeration of output types.
LogRecordsTextFilter:
properties:
column_id:
type: string
title: Column Id
description: ID of the column to filter.
operator:
type: string
enum:
- eq
- ne
- contains
- one_of
- not_in
title: Operator
value:
anyOf:
- type: string
- items:
type: string
type: array
title: Value
case_sensitive:
type: boolean
title: Case Sensitive
default: true
type:
type: string
const: text
title: Type
default: text
type: object
required:
- column_id
- operator
- value
title: LogRecordsTextFilter
CustomDashboardSectionUpdateRequest:
properties:
name:
anyOf:
- type: string
maxLength: 100
minLength: 1
- type: 'null'
title: Name
description:
anyOf:
- type: string
maxLength: 500
- type: 'null'
title: Description
color:
anyOf:
- type: string
maxLength: 7
pattern: ^#[0-9A-Fa-f]{6}$
- type: 'null'
title: Color
type: object
title: CustomDashboardSectionUpdateRequest
RollUpMethodDisplayOptions:
type: string
enum:
- average
- sum
- max
- min
- category_count
- percentage_true
- percentage_false
title: RollUpMethodDisplayOptions
description: 'Display options for roll up methods when showing rolled up metrics in the UI.
Separates display intent from computation methods. The computation methods
(NumericRollUpMethod, CategoricalRollUpMethod) control what aggregations are available.
This enum controls how the UI displays the selected roll-up value for a scorer.'
LogRecordsAvailableColumnsResponse:
properties:
columns:
items:
$ref: '#/components/schemas/LogRecordsColumnInfo'
type: array
title: Columns
type: object
title: LogRecordsAvailableColumnsResponse
examples:
- columns:
- applicable_types:
- control
- tool
- session
- trace
- agent
- llm
- workflow
- retriever
category: standard
data_type: text
description: Input to the trace or span.
filter_type: text
filterable: true
group_label: Standard
id: input
is_empty: false
is_optional: false
label: Input
multi_valued: false
sortable: true
- applicable_types:
- control
- tool
- session
- trace
- agent
- llm
- workflow
- retriever
category: standard
data_type: text
description: Output of the trace or span.
filter_type: text
filterable: true
group_label: Standard
id: output
is_empty: false
is_optional: false
label: Output
multi_valued: false
sortable: true
- applicable_types:
- control
- tool
- session
- trace
- agent
- llm
- workflow
- retriever
category: standard
data_type: text
description: Name of the trace, span or session.
filter_type: text
filterable: true
group_label: Standard
id: name
is_empty: false
is_optional: false
label: Name
multi_valued: false
sortable: true
- applicable_types:
- control
- tool
- session
- trace
- agent
- llm
- workflow
- retriever
category: standard
data_type: timestamp
description: Timestamp of the trace or span's creation.
filter_type: date
filterable: true
group_label: Standard
id: created_at
is_empty: false
is_optional: false
label: Created
multi_valued: false
sortable: true
- applicable_types:
- control
- tool
- trace
- agent
- llm
- workflow
- retriever
category: standard
data_type: string_list
description: Tags associated with this trace or span.
filter_type: collection
filterable: true
group_label: Standard
id: tags
is_empty: false
is_optional: false
label: Tags
multi_valued: true
sortable: false
- applicable_types:
- control
- tool
- trace
- agent
- llm
- workflow
- retriever
category: standard
data_type: integer
description: Status code of the trace or span. Used for logging failure or error states.
filter_type: number
filterable: true
group_label: Standard
id: status_code
is_empty: false
is_optional: true
label: Status Code
multi_valued: false
sortable: true
- applicable_types:
- control
- tool
- session
- trace
- agent
- llm
- workflow
- retriever
category: standard
data_type: text
description: A user-provided session, trace or span ID.
filter_type: text
filterable: true
group_label: Standard
id: external_id
is_empty: false
is_optional: true
label: External Id
multi_valued: false
sortable: true
- applicable_types:
- control
- tool
- trace
- agent
- llm
- workflow
- retriever
category: standard
data_type: text
description: Input to the dataset associated with this trace
filter_type: text
filterable: true
group_label: Standard
id: dataset_input
is_empty: false
is_optional: false
label: Dataset Input
multi_valued: false
sortable: true
- applicable_types:
- control
- tool
- trace
- agent
- llm
- workflow
- retriever
category: standard
data_type: text
description: Output from the dataset associated with this trace
filter_type: text
filterable: true
group_label: Standard
id: dataset_output
is_empty: false
is_optional: false
label: Dataset Output
multi_valued: false
sortable: true
- applicable_types:
- control
- tool
- session
- trace
- agent
- llm
- workflow
- retriever
category: standard
data_type: uuid
description: Galileo ID of the session, trace or span
filter_type: id
filterable: true
group_label: Standard
id: id
is_empty: false
is_optional: false
label: ID
multi_valued: false
sortable: true
- applicable_types:
- control
- tool
- trace
- agent
- llm
- workflow
- retriever
category: standard
data_type: uuid
description: Galileo ID of the session containing the trace (or the same value as id for a trace)
filter_type: id
filterable: true
group_label: Standard
id: session_id
is_empty: false
is_optional: false
label: Session ID
multi_valued: false
sortable: true
- applicable_types:
- control
- tool
- trace
- agent
- llm
- workflow
- retriever
category: standard
data_type: uuid
description: Galileo ID of the project associated with this trace or span
filter_type: id
filterable: true
group_label: Standard
id: project_id
is_empty: false
is_optional: false
label: Project ID
multi_valued: false
sortable: true
- applicable_types:
- control
- tool
- trace
- agent
- llm
- workflow
- retriever
category: standard
data_type: uuid
description: Galileo ID of the run (log stream or experiment) associated with this trace or span
filter_type: id
filterable: true
# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/galileo-technologies/refs/heads/main/openapi/galileo-technologies-custom-dashboards-api-openapi.yml