Create insights view | Opik Documentation

Create a new insights view in a workspace

Request

This endpoint expects an object.

namestringRequired1-120 characters

configobjectRequired

project_idstringOptionalformat: "uuid"

Project ID. Takes precedence over project_name when both are provided.

project_namestringOptionalformat: "(?s)^\s*(\S.*\S|\S)\s*$"

For project scope, specify either project_id or project_name. If project_name is provided and the project does not exist, it will be created. Ignored when project_id is provided. If neither is provided, the dashboard is created at workspace level.

typeenumOptional

Allowed values:

descriptionstringOptional0-1000 characters

Response headers

Locationstring

Response

Created

namestring1-120 characters

configobject

idstringRead-onlyformat: "uuid"

workspace_idstringRead-only

project_idstringformat: "uuid"

Project ID. Takes precedence over project_name when both are provided.

slugstringRead-only

typeenum

Allowed values:

scopeenumRead-only

Allowed values:

descriptionstring0-1000 characters

created_bystringRead-only

last_updated_bystringRead-only

created_atdatetimeRead-only

last_updated_atdatetimeRead-only

1	curl -X POST http://localhost:5173/api/v1/private/insights-views \
2	-H "Content-Type: application/json" \
3	-d '{
4	"name": "Team Performance Overview",
5	"config": {}
6	}'

1	{
2	"name": "Team Performance Overview",
3	"config": {},
4	"id": "d4f5a8b2-9c3e-4f7a-8b1e-2a7f9c6d5e4b",
5	"workspace_id": "workspace-12345",
6	"project_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
7	"slug": "team-performance-overview",
8	"type": "multi_project",
9	"scope": "workspace",
10	"description": "Dashboard showing key performance metrics across multiple projects within the workspace.",
11	"created_by": "user_jane_doe",
12	"last_updated_by": "user_jane_doe",
13	"created_at": "2024-01-15T09:30:00Z",
14	"last_updated_at": "2024-01-15T09:30:00Z"
15	}