Skip to main content
POST
Create Evaluation Dashboard

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string | null

Body

application/json
name
string
required

Dashboard name

Required string length: 1 - 256
tags
string[]

The tags associated with the entity

description
string

Optional description of the dashboard

evaluation_id
string

Evaluation ID (XOR with evaluation_group_id)

evaluation_group_id
string

Evaluation group ID (XOR with evaluation_id)

widget_order
string[]

Ordered array of widget IDs to display on this dashboard

template_dashboard_id
string

Optional dashboard ID to use as template. Copies widget_order from template.

Response

Successful Response

id
string
required

Unique identifier of the dashboard

created_by
Identity · object
required

The identity that created the entity.

tags
string[]
required

The tags associated with the entity

name
string
required

Dashboard name

account_id
string
required

Account that owns this dashboard

created_at
string<date-time>
required

When the dashboard was created

updated_at
string<date-time>
required

When the dashboard was last updated

object
string
default:evaluation_dashboard
Allowed value: "evaluation_dashboard"
description
string

Dashboard description

evaluation_id
string

Evaluation ID

evaluation_group_id
string

Evaluation group ID

widget_order
string[]

Ordered array of widget IDs

error_message
string

Error message if computation failed

archived_at
string<date-time>

When the dashboard was archived (soft-deleted)

widgets
Widgets · object[]

Widgets associated with this dashboard. Populated with 'widgets' view.

widget_results
Widget Results · object[]

Widget results for this dashboard. Populated with 'widget_results' view.