Skip to main content
PATCH
/
v1
/
eval_status_page
/
{eval_status_page_id}
Partially update eval_status_page
curl --request PATCH \
  --url https://api.braintrust.dev/v1/eval_status_page/{eval_status_page_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "logo_url": "<string>",
  "theme": "light",
  "config": {
    "score_columns": [
      "<string>"
    ],
    "metric_columns": [
      "<string>"
    ],
    "grouping_field": "<string>",
    "filter": "<string>",
    "sort_by": "<string>",
    "sort_order": "asc",
    "api_key": "<string>"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "theme": "light",
  "config": {
    "score_columns": [
      "<string>"
    ],
    "metric_columns": [
      "<string>"
    ],
    "grouping_field": "<string>",
    "filter": "<string>",
    "sort_by": "<string>",
    "sort_order": "asc",
    "api_key": "<string>"
  },
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "logo_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Most Braintrust endpoints are authenticated by providing your API key as a header Authorization: Bearer [api_key] to your HTTP request. You can create an API key in the Braintrust organization settings page.

Path Parameters

​
eval_status_page_id
string<uuid>
required

EvalStatusPage id

Body

application/json

Fields to update

​
name
string | null

Name of the eval status page

​
description
string | null

Textual description of the eval status page

​
logo_url
string | null

URL of the logo to display on the page

​
theme
enum<string> | null

The theme for the page

Available options:
light,
dark
​
config
object

Configuration for what data to display

Response

Returns the eval_status_page object

A public eval status page that displays aggregate experiment results

​
id
string<uuid>
required

Unique identifier for the eval status page

​
project_id
string<uuid>
required

Unique identifier for the project that the eval status page belongs under

​
name
string
required

Name of the eval status page

​
theme
enum<string>
required

The theme for the page

Available options:
light,
dark
​
config
object
required

Configuration for what data to display

​
user_id
string<uuid> | null

Identifies the user who created the eval status page

​
created
string<date-time> | null

Date of eval status page creation

​
deleted_at
string<date-time> | null

Date of eval status page deletion, or null if the eval status page is still active

​
description
string | null

Textual description of the eval status page

​
logo_url
string | null

URL of the logo to display on the page