Update chart

Update a chart.

PATCH /api/v1/charts/{chart_id}

Error

A valid request URL is required to generate request examples

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "index": 123,
  "section_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "series": [
    {
      "name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "filters": {
        "filter": "<string>",
        "trace_filter": "<string>",
        "tree_filter": "<string>",
        "session": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ]
      },
      "feedback_key": "<string>",
      "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metric_definition": {
        "type": "count",
        "filter": "<string>"
      },
      "group_by_definitions": [
        {
          "attribute": "<string>"
        }
      ],
      "filter_definition": {
        "source_type": "<string>",
        "project_ids": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "run_filter": "<string>",
        "trace_filter": "<string>",
        "tree_filter": "<string>"
      },
      "group_by": {
        "path": "<string>",
        "max_groups": 5
      }
    }
  ],
  "description": "<string>",
  "metadata": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Path Parameters

chart_id · string<uuid> · required

Body

application/json

title · string Missing · object · default: {"__missing__":"__missing__"}

description · string Missing · object · default: {"__missing__":"__missing__"}

index · integer · default: {"__missing__":"__missing__"}

Required range: 0 <= x <= 100

chart_type · enum<string> Missing · object · default: {"__missing__":"__missing__"}

Enum for custom chart types.

Available options: line, bar, table, kpi, top-k, pie

series · CustomChartSeriesUpdate · object

CustomChartSeriesUpdate · object[]

Missing · object

Show child attributes

section_id · string<uuid> Missing · object · default: {"__missing__":"__missing__"}

metadata · Metadata · object

Metadata

Missing

common_filters · CustomChartSeriesFilters · object

CustomChartSeriesFilters

Missing

Show child attributes

Response

200

application/json

Successful Response

id · string<uuid> · required

title · string · required

index · integer · required

chart_type · enum<string> · required

Enum for custom chart types.

Available options: line, bar, table, kpi, top-k, pie

section_id · string<uuid> · required

series · CustomChartSeries · object[] | null · required

Show child attributes

description · string | null

metadata · Metadata · object | null