Skip to main content
GET
Get view

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

view_id
string<uuid>
required

View id

Query Parameters

object_type
enum<string>
required

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
object_id
string<uuid>
required

The id of the object the ACL applies to

Response

Returns the view object

id
string<uuid>
required

Unique identifier for the view

object_type
enum<string>
required

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
object_id
string<uuid>
required

The id of the object the view applies to

view_type
enum<string>
required

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
string
required

Name of the view

created
string<date-time> | null

Date of view creation

view_data
object | null

The view definition

options
MonitorViewOptions · object

Options for the view in the app

user_id
string<uuid> | null

Identifies the user who created the view

deleted_at
string<date-time> | null

Date of role deletion, or null if the role is still active