Partially update view
curl --request PATCH \
--url https://api.braintrust.dev/v1/view/{view_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"starred": true,
"view_data": {
"search": {
"filter": [
null
],
"tag": [
null
],
"match": [
null
],
"sort": [
null
]
},
"custom_charts": null
},
"options": {
"viewType": "monitor",
"options": {
"rangeValue": "<string>",
"frameStart": "<string>",
"frameEnd": "<string>",
"tzUTC": true,
"chartVisibility": {},
"projectId": "<string>",
"groupBy": "<string>"
},
"freezeColumns": true
},
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.braintrust.dev/v1/view/{view_id}"
payload = {
"object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"starred": True,
"view_data": {
"search": {
"filter": [None],
"tag": [None],
"match": [None],
"sort": [None]
},
"custom_charts": None
},
"options": {
"viewType": "monitor",
"options": {
"rangeValue": "<string>",
"frameStart": "<string>",
"frameEnd": "<string>",
"tzUTC": True,
"chartVisibility": {},
"projectId": "<string>",
"groupBy": "<string>"
},
"freezeColumns": True
},
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
object_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
description: '<string>',
starred: true,
view_data: {
search: {filter: [null], tag: [null], match: [null], sort: [null]},
custom_charts: null
},
options: {
viewType: 'monitor',
options: {
rangeValue: '<string>',
frameStart: '<string>',
frameEnd: '<string>',
tzUTC: true,
chartVisibility: {},
projectId: '<string>',
groupBy: '<string>'
},
freezeColumns: true
},
user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.braintrust.dev/v1/view/{view_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.braintrust.dev/v1/view/{view_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'object_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'description' => '<string>',
'starred' => true,
'view_data' => [
'search' => [
'filter' => [
null
],
'tag' => [
null
],
'match' => [
null
],
'sort' => [
null
]
],
'custom_charts' => null
],
'options' => [
'viewType' => 'monitor',
'options' => [
'rangeValue' => '<string>',
'frameStart' => '<string>',
'frameEnd' => '<string>',
'tzUTC' => true,
'chartVisibility' => [
],
'projectId' => '<string>',
'groupBy' => '<string>'
],
'freezeColumns' => true
],
'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.braintrust.dev/v1/view/{view_id}"
payload := strings.NewReader("{\n \"object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"starred\": true,\n \"view_data\": {\n \"search\": {\n \"filter\": [\n null\n ],\n \"tag\": [\n null\n ],\n \"match\": [\n null\n ],\n \"sort\": [\n null\n ]\n },\n \"custom_charts\": null\n },\n \"options\": {\n \"viewType\": \"monitor\",\n \"options\": {\n \"rangeValue\": \"<string>\",\n \"frameStart\": \"<string>\",\n \"frameEnd\": \"<string>\",\n \"tzUTC\": true,\n \"chartVisibility\": {},\n \"projectId\": \"<string>\",\n \"groupBy\": \"<string>\"\n },\n \"freezeColumns\": true\n },\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.braintrust.dev/v1/view/{view_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"starred\": true,\n \"view_data\": {\n \"search\": {\n \"filter\": [\n null\n ],\n \"tag\": [\n null\n ],\n \"match\": [\n null\n ],\n \"sort\": [\n null\n ]\n },\n \"custom_charts\": null\n },\n \"options\": {\n \"viewType\": \"monitor\",\n \"options\": {\n \"rangeValue\": \"<string>\",\n \"frameStart\": \"<string>\",\n \"frameEnd\": \"<string>\",\n \"tzUTC\": true,\n \"chartVisibility\": {},\n \"projectId\": \"<string>\",\n \"groupBy\": \"<string>\"\n },\n \"freezeColumns\": true\n },\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.braintrust.dev/v1/view/{view_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"starred\": true,\n \"view_data\": {\n \"search\": {\n \"filter\": [\n null\n ],\n \"tag\": [\n null\n ],\n \"match\": [\n null\n ],\n \"sort\": [\n null\n ]\n },\n \"custom_charts\": null\n },\n \"options\": {\n \"viewType\": \"monitor\",\n \"options\": {\n \"rangeValue\": \"<string>\",\n \"frameStart\": \"<string>\",\n \"frameEnd\": \"<string>\",\n \"tzUTC\": true,\n \"chartVisibility\": {},\n \"projectId\": \"<string>\",\n \"groupBy\": \"<string>\"\n },\n \"freezeColumns\": true\n },\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object_type": "organization",
"object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"view_type": "projects",
"name": "<string>",
"description": "<string>",
"starred": true,
"created": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"view_data": {
"search": {
"filter": [
null
],
"tag": [
null
],
"match": [
null
],
"sort": [
null
]
},
"custom_charts": null
},
"options": {
"viewType": "monitor",
"options": {
"filterScope": "span",
"spanType": "range",
"rangeValue": "<string>",
"frameStart": "<string>",
"frameEnd": "<string>",
"tzUTC": true,
"chartVisibility": {},
"projectId": "<string>",
"type": "project",
"groupBy": "<string>"
},
"freezeColumns": true
},
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deleted_at": "2023-11-07T05:31:56Z"
}<string><string><string><string><string>Views
Partially update view
Partially update a view object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null.
PATCH
/
v1
/
view
/
{view_id}
Partially update view
curl --request PATCH \
--url https://api.braintrust.dev/v1/view/{view_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"starred": true,
"view_data": {
"search": {
"filter": [
null
],
"tag": [
null
],
"match": [
null
],
"sort": [
null
]
},
"custom_charts": null
},
"options": {
"viewType": "monitor",
"options": {
"rangeValue": "<string>",
"frameStart": "<string>",
"frameEnd": "<string>",
"tzUTC": true,
"chartVisibility": {},
"projectId": "<string>",
"groupBy": "<string>"
},
"freezeColumns": true
},
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.braintrust.dev/v1/view/{view_id}"
payload = {
"object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"starred": True,
"view_data": {
"search": {
"filter": [None],
"tag": [None],
"match": [None],
"sort": [None]
},
"custom_charts": None
},
"options": {
"viewType": "monitor",
"options": {
"rangeValue": "<string>",
"frameStart": "<string>",
"frameEnd": "<string>",
"tzUTC": True,
"chartVisibility": {},
"projectId": "<string>",
"groupBy": "<string>"
},
"freezeColumns": True
},
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
object_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
description: '<string>',
starred: true,
view_data: {
search: {filter: [null], tag: [null], match: [null], sort: [null]},
custom_charts: null
},
options: {
viewType: 'monitor',
options: {
rangeValue: '<string>',
frameStart: '<string>',
frameEnd: '<string>',
tzUTC: true,
chartVisibility: {},
projectId: '<string>',
groupBy: '<string>'
},
freezeColumns: true
},
user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.braintrust.dev/v1/view/{view_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.braintrust.dev/v1/view/{view_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'object_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'description' => '<string>',
'starred' => true,
'view_data' => [
'search' => [
'filter' => [
null
],
'tag' => [
null
],
'match' => [
null
],
'sort' => [
null
]
],
'custom_charts' => null
],
'options' => [
'viewType' => 'monitor',
'options' => [
'rangeValue' => '<string>',
'frameStart' => '<string>',
'frameEnd' => '<string>',
'tzUTC' => true,
'chartVisibility' => [
],
'projectId' => '<string>',
'groupBy' => '<string>'
],
'freezeColumns' => true
],
'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.braintrust.dev/v1/view/{view_id}"
payload := strings.NewReader("{\n \"object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"starred\": true,\n \"view_data\": {\n \"search\": {\n \"filter\": [\n null\n ],\n \"tag\": [\n null\n ],\n \"match\": [\n null\n ],\n \"sort\": [\n null\n ]\n },\n \"custom_charts\": null\n },\n \"options\": {\n \"viewType\": \"monitor\",\n \"options\": {\n \"rangeValue\": \"<string>\",\n \"frameStart\": \"<string>\",\n \"frameEnd\": \"<string>\",\n \"tzUTC\": true,\n \"chartVisibility\": {},\n \"projectId\": \"<string>\",\n \"groupBy\": \"<string>\"\n },\n \"freezeColumns\": true\n },\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.braintrust.dev/v1/view/{view_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"starred\": true,\n \"view_data\": {\n \"search\": {\n \"filter\": [\n null\n ],\n \"tag\": [\n null\n ],\n \"match\": [\n null\n ],\n \"sort\": [\n null\n ]\n },\n \"custom_charts\": null\n },\n \"options\": {\n \"viewType\": \"monitor\",\n \"options\": {\n \"rangeValue\": \"<string>\",\n \"frameStart\": \"<string>\",\n \"frameEnd\": \"<string>\",\n \"tzUTC\": true,\n \"chartVisibility\": {},\n \"projectId\": \"<string>\",\n \"groupBy\": \"<string>\"\n },\n \"freezeColumns\": true\n },\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.braintrust.dev/v1/view/{view_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"object_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"starred\": true,\n \"view_data\": {\n \"search\": {\n \"filter\": [\n null\n ],\n \"tag\": [\n null\n ],\n \"match\": [\n null\n ],\n \"sort\": [\n null\n ]\n },\n \"custom_charts\": null\n },\n \"options\": {\n \"viewType\": \"monitor\",\n \"options\": {\n \"rangeValue\": \"<string>\",\n \"frameStart\": \"<string>\",\n \"frameEnd\": \"<string>\",\n \"tzUTC\": true,\n \"chartVisibility\": {},\n \"projectId\": \"<string>\",\n \"groupBy\": \"<string>\"\n },\n \"freezeColumns\": true\n },\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object_type": "organization",
"object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"view_type": "projects",
"name": "<string>",
"description": "<string>",
"starred": true,
"created": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"view_data": {
"search": {
"filter": [
null
],
"tag": [
null
],
"match": [
null
],
"sort": [
null
]
},
"custom_charts": null
},
"options": {
"viewType": "monitor",
"options": {
"filterScope": "span",
"spanType": "range",
"rangeValue": "<string>",
"frameStart": "<string>",
"frameEnd": "<string>",
"tzUTC": true,
"chartVisibility": {},
"projectId": "<string>",
"type": "project",
"groupBy": "<string>"
},
"freezeColumns": true
},
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deleted_at": "2023-11-07T05:31:56Z"
}<string><string><string><string><string>Authorizations
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
View id
Body
application/json
Fields to update
The object type that the ACL applies to
Available options:
organization, project, experiment, dataset, prompt, prompt_session, group, role, org_member, project_log, org_project, org_audit_logs, project_group, project_group_projects, ai_secret, org_ai_secret, org_account The id of the object the view applies to
Type of object that the view corresponds to.
Available options:
projects, experiments, experiment, playgrounds, playground, datasets, dataset, prompts, parameters, tools, scorers, classifiers, logs, monitor, for_review_project_log, for_review_experiments, for_review_datasets, null Name of the view
Textual description of the view
Whether the view is starred in its project
The view definition
Show child attributes
Show child attributes
Options for the view in the app
- MonitorViewOptions
- TableViewOptions
Show child attributes
Show child attributes
Identifies the user who created the view
Response
Returns the view object
Unique identifier for the view
The object type that the ACL applies to
Available options:
organization, project, experiment, dataset, prompt, prompt_session, group, role, org_member, project_log, org_project, org_audit_logs, project_group, project_group_projects, ai_secret, org_ai_secret, org_account The id of the object the view applies to
Type of object that the view corresponds to.
Available options:
projects, experiments, experiment, playgrounds, playground, datasets, dataset, prompts, parameters, tools, scorers, classifiers, logs, monitor, for_review_project_log, for_review_experiments, for_review_datasets, null Name of the view
Textual description of the view
Whether the view is starred in its project
Date of view creation
Date of last view update
The view definition
Show child attributes
Show child attributes
Options for the view in the app
- MonitorViewOptions
- TableViewOptions
Show child attributes
Show child attributes
Identifies the user who created the view
Date of role deletion, or null if the role is still active
Was this page helpful?