Widgets

Overview

The Confident AI SDK exposes every Widget method on the platform. This page documents how to call these methods in all supported languages. See the introduction to install the SDK and set your API key.

Methods

Adds a widget to a dashboard and returns its id. Send layout to place it yourself, or leave it out and Confident AI puts it on the first free row below the widgets already there.

from confident_ai import ConfidentAI
from confident_ai.common import FilterSet
from confident_ai.common import WidgetLayout
from confident_ai.common import WidgetLineConfig
from confident_ai.common import WidgetTopK

client = ConfidentAI()

result = client.dashboards.create_widget(
    dashboard_id="<DASHBOARD-ID>",
    name="Trace volume",
    description="Traces served per day across production.",
    type="LINE",
    unit="COUNT",
    mode="TIME_SERIES",
    bucket_mode="SERIES",
    dimension="model",
    top_k=WidgetTopK(
        limit=10,
        order_by="p90_latency",
        direction="desc"
    ),
    start_time="2025-01-01T00:00:00+00:00",
    end_time="2025-01-31T23:59:59.999000+00:00",
    layout=WidgetLayout(
        x=0,
        y=0,
        w=6,
        h=2
    ),
    lines=[
        WidgetLineConfig(
            name="Traces",
            color="BLUE",
            data_model="TRACE",
            aggregation="COUNT",
            filters=FilterSet(
                operator="AND",
                groups=[]
            ),
            extra_query_params={"metricMetadataKey": "tokenCount"}
        )
    ],
)

For async mode, call a_create_widget and await it as shown below:

result = await client.dashboards.a_create_widget(...)

Parameters

Parameter	Type	Description
`dashboard_id`	`str`	Required. The id of the dashboard.
`name`	`str`	Required. The name shown as the widget's title.
`description`	`Optional[str]`	What the widget shows. Send null to leave it unset.
`type`	`Optional[WidgetType]`	The visualization to draw the widget as. See WidgetType.
`unit`	`Optional[WidgetUnit]`	The unit the widget's values are labelled with. See WidgetUnit.
`mode`	`Optional[WidgetMode]`	How the widget aggregates its lines. `DIMENSION_SERIES` requires `dimension`. See WidgetMode.
`bucket_mode`	`Optional[WidgetBucketMode]`	How the query range is bucketed. Defaults to `SERIES` when omitted. See WidgetBucketMode.
`dimension`	`Optional[WidgetDimension]`	The property to break the widget's data down by. Required when `mode` is `DIMENSION_SERIES`. See WidgetDimension.
`top_k`	`Optional[WidgetTopK]`	Caps a dimension breakdown at its top values. Send null, or omit it, to plot every value. See WidgetTopK.
`start_time`	`Optional[str]`	The start of the widget's own time range, as an ISO 8601 datetime. Send null to let the query decide the range.
`end_time`	`Optional[str]`	The end of the widget's own time range, as an ISO 8601 datetime. Send null to let the query decide the range.
`layout`	`Optional[WidgetLayout]`	Where the widget sits on the dashboard grid. Omit it, or send null, and Confident AI packs the widget into the first free space. See WidgetLayout.
`lines`	`Optional[List[WidgetLineConfig]]`	The series the widget plots. See WidgetLineConfig.

import { ConfidentAI } from "confident-ai";

const client = new ConfidentAI();

const result = await client.dashboards.createWidget(
  "<DASHBOARD-ID>",
  "Trace volume",
  {
    description: "Traces served per day across production.",
    type: "LINE",
    unit: "COUNT",
    mode: "TIME_SERIES",
    bucketMode: "SERIES",
    dimension: "model",
    topK: {
      limit: 10,
      orderBy: "p90_latency",
      direction: "desc"
    },
    startTime: "2025-01-01T00:00:00+00:00",
    endTime: "2025-01-31T23:59:59.999000+00:00",
    layout: {
      x: 0,
      y: 0,
      w: 6,
      h: 2
    },
    lines: [
      {
        name: "Traces",
        color: "BLUE",
        dataModel: "TRACE",
        aggregation: "COUNT",
        filters: {
            operator: "AND",
            groups: []
          },
        extraQueryParams: { metricMetadataKey: "tokenCount" }
      }
    ]
  },
);

Parameters

Parameter	Type	Description
`dashboardId`	`string`	Required. The id of the dashboard.
`name`	`string`	Required. The name shown as the widget's title.
`description`	`string \| null`	What the widget shows. Send null to leave it unset.
`type`	`WidgetType \| null`	The visualization to draw the widget as. See WidgetType.
`unit`	`WidgetUnit \| null`	The unit the widget's values are labelled with. See WidgetUnit.
`mode`	`WidgetMode \| null`	How the widget aggregates its lines. `DIMENSION_SERIES` requires `dimension`. See WidgetMode.
`bucketMode`	`WidgetBucketMode \| null`	How the query range is bucketed. Defaults to `SERIES` when omitted. See WidgetBucketMode.
`dimension`	`WidgetDimension \| null`	The property to break the widget's data down by. Required when `mode` is `DIMENSION_SERIES`. See WidgetDimension.
`topK`	`WidgetTopK \| null`	Caps a dimension breakdown at its top values. Send null, or omit it, to plot every value. See WidgetTopK.
`startTime`	`string \| null`	The start of the widget's own time range, as an ISO 8601 datetime. Send null to let the query decide the range.
`endTime`	`string \| null`	The end of the widget's own time range, as an ISO 8601 datetime. Send null to let the query decide the range.
`layout`	`WidgetLayout \| null`	Where the widget sits on the dashboard grid. Omit it, or send null, and Confident AI packs the widget into the first free space. See WidgetLayout.
`lines`	`WidgetLineConfig[] \| null`	The series the widget plots. See WidgetLineConfig.

Returns

This method returns an object of type WidgetRef.

Replaces a widget's configuration and returns it. This is a full replacement: every field you leave out is cleared, apart from layout and lines, which keep what is stored until you send them. Sending lines replaces the widget's lines outright, so the returned lines have new ids.

from confident_ai import ConfidentAI
from confident_ai.common import FilterSet
from confident_ai.common import WidgetLayout
from confident_ai.common import WidgetLineConfig
from confident_ai.common import WidgetTopK

client = ConfidentAI()

result = client.dashboards.update_widget(
    dashboard_id="<DASHBOARD-ID>",
    widget_id="<WIDGET-ID>",
    name="Trace volume",
    description="Traces served per day across production.",
    type="LINE",
    unit="COUNT",
    mode="TIME_SERIES",
    bucket_mode="SERIES",
    dimension="model",
    top_k=WidgetTopK(
        limit=10,
        order_by="p90_latency",
        direction="desc"
    ),
    start_time="2025-01-01T00:00:00+00:00",
    end_time="2025-01-31T23:59:59.999000+00:00",
    layout=WidgetLayout(
        x=0,
        y=0,
        w=6,
        h=2
    ),
    lines=[
        WidgetLineConfig(
            name="Traces",
            color="BLUE",
            data_model="TRACE",
            aggregation="COUNT",
            filters=FilterSet(
                operator="AND",
                groups=[]
            ),
            extra_query_params={"metricMetadataKey": "tokenCount"}
        )
    ],
)

For async mode, call a_update_widget and await it as shown below:

result = await client.dashboards.a_update_widget(...)

Parameters

Parameter	Type	Description
`dashboard_id`	`str`	Required. The id of the dashboard the widget is on.
`widget_id`	`str`	Required. The id of the widget.
`name`	`str`	Required. The name shown as the widget's title.
`description`	`Optional[str]`	What the widget shows. Send null to leave it unset.
`type`	`Optional[WidgetType]`	The visualization to draw the widget as. See WidgetType.
`unit`	`Optional[WidgetUnit]`	The unit the widget's values are labelled with. See WidgetUnit.
`mode`	`Optional[WidgetMode]`	How the widget aggregates its lines. `DIMENSION_SERIES` requires `dimension`. See WidgetMode.
`bucket_mode`	`Optional[WidgetBucketMode]`	How the query range is bucketed. Defaults to `SERIES` when omitted. See WidgetBucketMode.
`dimension`	`Optional[WidgetDimension]`	The property to break the widget's data down by. Required when `mode` is `DIMENSION_SERIES`. See WidgetDimension.
`top_k`	`Optional[WidgetTopK]`	Caps a dimension breakdown at its top values. Send null, or omit it, to plot every value. See WidgetTopK.
`start_time`	`Optional[str]`	The start of the widget's own time range, as an ISO 8601 datetime. Send null to let the query decide the range.
`end_time`	`Optional[str]`	The end of the widget's own time range, as an ISO 8601 datetime. Send null to let the query decide the range.
`layout`	`Optional[WidgetLayout]`	Where the widget sits on the dashboard grid. Omit it, or send null, and Confident AI packs the widget into the first free space. See WidgetLayout.
`lines`	`Optional[List[WidgetLineConfig]]`	The series the widget plots. See WidgetLineConfig.

import { ConfidentAI } from "confident-ai";

const client = new ConfidentAI();

const result = await client.dashboards.updateWidget(
  "<DASHBOARD-ID>",
  "<WIDGET-ID>",
  "Trace volume",
  {
    description: "Traces served per day across production.",
    type: "LINE",
    unit: "COUNT",
    mode: "TIME_SERIES",
    bucketMode: "SERIES",
    dimension: "model",
    topK: {
      limit: 10,
      orderBy: "p90_latency",
      direction: "desc"
    },
    startTime: "2025-01-01T00:00:00+00:00",
    endTime: "2025-01-31T23:59:59.999000+00:00",
    layout: {
      x: 0,
      y: 0,
      w: 6,
      h: 2
    },
    lines: [
      {
        name: "Traces",
        color: "BLUE",
        dataModel: "TRACE",
        aggregation: "COUNT",
        filters: {
            operator: "AND",
            groups: []
          },
        extraQueryParams: { metricMetadataKey: "tokenCount" }
      }
    ]
  },
);

Parameters

Parameter	Type	Description
`dashboardId`	`string`	Required. The id of the dashboard the widget is on.
`widgetId`	`string`	Required. The id of the widget.
`name`	`string`	Required. The name shown as the widget's title.
`description`	`string \| null`	What the widget shows. Send null to leave it unset.
`type`	`WidgetType \| null`	The visualization to draw the widget as. See WidgetType.
`unit`	`WidgetUnit \| null`	The unit the widget's values are labelled with. See WidgetUnit.
`mode`	`WidgetMode \| null`	How the widget aggregates its lines. `DIMENSION_SERIES` requires `dimension`. See WidgetMode.
`bucketMode`	`WidgetBucketMode \| null`	How the query range is bucketed. Defaults to `SERIES` when omitted. See WidgetBucketMode.
`dimension`	`WidgetDimension \| null`	The property to break the widget's data down by. Required when `mode` is `DIMENSION_SERIES`. See WidgetDimension.
`topK`	`WidgetTopK \| null`	Caps a dimension breakdown at its top values. Send null, or omit it, to plot every value. See WidgetTopK.
`startTime`	`string \| null`	The start of the widget's own time range, as an ISO 8601 datetime. Send null to let the query decide the range.
`endTime`	`string \| null`	The end of the widget's own time range, as an ISO 8601 datetime. Send null to let the query decide the range.
`layout`	`WidgetLayout \| null`	Where the widget sits on the dashboard grid. Omit it, or send null, and Confident AI packs the widget into the first free space. See WidgetLayout.
`lines`	`WidgetLineConfig[] \| null`	The series the widget plots. See WidgetLineConfig.

Returns

This method returns an object of type Widget.

Removes a widget from a dashboard. A widget shown on other dashboards is only taken off this one; the last dashboard to drop it deletes it and its lines for good.

from confident_ai import ConfidentAI

client = ConfidentAI()

result = client.dashboards.delete_widget(
    dashboard_id="<DASHBOARD-ID>",
    widget_id="<WIDGET-ID>",
)

For async mode, call a_delete_widget and await it as shown below:

result = await client.dashboards.a_delete_widget(...)

Parameters

Parameter	Type	Description
`dashboard_id`	`str`	Required. The id of the dashboard the widget is on.
`widget_id`	`str`	Required. The id of the widget.

import { ConfidentAI } from "confident-ai";

const client = new ConfidentAI();

const result = await client.dashboards.deleteWidget(
  "<DASHBOARD-ID>",
  "<WIDGET-ID>",
);

Parameters

Parameter	Type	Description
`dashboardId`	`string`	Required. The id of the dashboard the widget is on.
`widgetId`	`string`	Required. The id of the widget.

Returns

This method returns an object of type WidgetRef.

Computes the data behind one widget. A time range you send overrides the widget's own for this query only. Branch on data.kind to read the result: the widget's type and mode say how it is drawn, not how the payload is shaped.

from confident_ai import ConfidentAI
from confident_ai.common import WidgetGranularity

client = ConfidentAI()

result = client.dashboards.query_widget(
    dashboard_id="<DASHBOARD-ID>",
    widget_id="<WIDGET-ID>",
    start_time="2025-01-01T00:00:00+00:00",
    end_time="2025-01-31T23:59:59.999000+00:00",
    granularity=WidgetGranularity.THIRTY_MINUTES,
)

For async mode, call a_query_widget and await it as shown below:

result = await client.dashboards.a_query_widget(...)

Parameters

Parameter	Type	Description
`dashboard_id`	`str`	Required. The id of the dashboard the widget is on.
`widget_id`	`str`	Required. The id of the widget.
`start_time`	`Optional[str]`	The start of the range to compute over, as an ISO 8601 datetime. Must be sent together with `endTime`, and overrides each widget's own range for this query only.
`end_time`	`Optional[str]`	The end of the range to compute over, as an ISO 8601 datetime. Must be sent together with `startTime`, and must be later than it.
`granularity`	`Optional[WidgetGranularity]`	See WidgetGranularity.

import { ConfidentAI } from "confident-ai";
import { WidgetGranularity } from "confident-ai/common";

const client = new ConfidentAI();

const result = await client.dashboards.queryWidget(
  "<DASHBOARD-ID>",
  "<WIDGET-ID>",
  {
    startTime: "2025-01-01T00:00:00+00:00",
    endTime: "2025-01-31T23:59:59.999000+00:00",
    granularity: WidgetGranularity.THIRTY_MINUTES
  },
);

Parameters

Parameter	Type	Description
`dashboardId`	`string`	Required. The id of the dashboard the widget is on.
`widgetId`	`string`	Required. The id of the widget.
`startTime`	`string`	The start of the range to compute over, as an ISO 8601 datetime. Must be sent together with `endTime`, and overrides each widget's own range for this query only.
`endTime`	`string`	The end of the range to compute over, as an ISO 8601 datetime. Must be sent together with `startTime`, and must be later than it.
`granularity`	`WidgetGranularity`	See WidgetGranularity.

Returns

This method returns an object of type WidgetQueryResult.

Types

FilterSet

A set of filter groups combined by a top-level operator. Each group combines its filter rows by its own operator, and each row matches one property, such as Name or User Id, against a value with a condition such as Is or Contains.

class FilterSet:
    operator: Literal["AND", "OR"]
    groups: List[FilterSetGroup]

operatorLiteral["AND", "OR"]Required

groupsList[FilterSetGroup]Required

interface FilterSet {
  operator: "AND" | "OR";
  groups: FilterSetGroup[];
}

operator"AND" | "OR"Required

groupsFilterSetGroup[]Required

One chart on a dashboard, with the configuration a query computes it from.

class Widget:
    id: str
    name: str
    description: Optional[str]
    type: Optional[WidgetType]
    unit: Optional[WidgetUnit]
    mode: Optional[WidgetMode]
    bucket_mode: Optional[WidgetBucketMode] = Field(alias="bucketMode")
    dimension: Optional[WidgetDimension]
    top_k: Optional[WidgetTopK] = Field(alias="topK")
    start_time: Optional[str] = Field(alias="startTime")
    end_time: Optional[str] = Field(alias="endTime")
    layout: Optional[WidgetLayout]
    lines: List[WidgetLine]

idstrRequired

The id of the widget, generated by Confident AI.

Example: "<WIDGET-ID>"

namestrRequired

The name shown as the widget's title.

Example: "Trace volume"

descriptionOptional[str]Required

What the widget shows, or null when it has no description.

Example: "Traces served per day across production."

typeOptional[WidgetType]Required

The visualization the widget is drawn as, or null when it has not been chosen.

See WidgetType.

unitOptional[WidgetUnit]Required

The unit the widget's values are labelled with, or null when it has none.

See WidgetUnit.

modeOptional[WidgetMode]Required

How the widget aggregates its lines, or null when it has not been chosen.

See WidgetMode.

bucket_modeOptional[WidgetBucketMode]Required

How the widget buckets its query range, or null when it uses the default of SERIES.

See WidgetBucketMode.

dimensionOptional[WidgetDimension]Required

The property the widget breaks its data down by, or null when it does not break it down.

See WidgetDimension.

top_kOptional[WidgetTopK]Required

The cap on the widget's dimension breakdown, or null when every value is plotted.

See WidgetTopK.

start_timeOptional[str]Required

The start of the widget's own time range, or null when it has none.

end_timeOptional[str]Required

The end of the widget's own time range, or null when it has none.

layoutOptional[WidgetLayout]Required

Where the widget sits on the dashboard grid, or null when it has no saved position.

See WidgetLayout.

linesList[WidgetLine]Required

The series the widget plots.

See WidgetLine.

interface Widget {
  id: string;
  name: string;
  description: string | null;
  type: WidgetType | null;
  unit: WidgetUnit | null;
  mode: WidgetMode | null;
  bucketMode: WidgetBucketMode | null;
  dimension: WidgetDimension | null;
  topK: WidgetTopK | null;
  startTime: string | null;
  endTime: string | null;
  layout: WidgetLayout | null;
  lines: WidgetLine[];
}

idstringRequired

The id of the widget, generated by Confident AI.

Example: "<WIDGET-ID>"

namestringRequired

The name shown as the widget's title.

Example: "Trace volume"

descriptionstring | nullRequired

What the widget shows, or null when it has no description.

Example: "Traces served per day across production."

typeWidgetType | nullRequired

The visualization the widget is drawn as, or null when it has not been chosen.

See WidgetType.

unitWidgetUnit | nullRequired

The unit the widget's values are labelled with, or null when it has none.

See WidgetUnit.

modeWidgetMode | nullRequired

How the widget aggregates its lines, or null when it has not been chosen.

See WidgetMode.

bucketModeWidgetBucketMode | nullRequired

How the widget buckets its query range, or null when it uses the default of SERIES.

See WidgetBucketMode.

dimensionWidgetDimension | nullRequired

The property the widget breaks its data down by, or null when it does not break it down.

See WidgetDimension.

topKWidgetTopK | nullRequired

The cap on the widget's dimension breakdown, or null when every value is plotted.

See WidgetTopK.

startTimestring | nullRequired

The start of the widget's own time range, or null when it has none.

endTimestring | nullRequired

The end of the widget's own time range, or null when it has none.

layoutWidgetLayout | nullRequired

Where the widget sits on the dashboard grid, or null when it has no saved position.

See WidgetLayout.

linesWidgetLine[]Required

The series the widget plots.

See WidgetLine.

WidgetAggregation

The aggregation a line computes, given as its token. Which tokens apply depends on the line's dataModel — AVG_RATING belongs to ANNOTATION lines, TOTAL_TOKENS to span lines — and a token that does not apply to the line's data model is rejected with the list of the ones that do.

class WidgetAggregation(Enum):
    AVG_COST = "AVG_COST"
    AVG_COST_PER_USER = "AVG_COST_PER_USER"
    AVG_LATENCY = "AVG_LATENCY"
    AVG_RATING = "AVG_RATING"
    AVG_SCORE = "AVG_SCORE"
    AVG_VALUE = "AVG_VALUE"
    COUNT = "COUNT"
    ERROR_COUNT = "ERROR_COUNT"
    ERROR_RATE = "ERROR_RATE"
    FAILURE_RATE = "FAILURE_RATE"
    INPUT_COST = "INPUT_COST"
    INPUT_TOKENS = "INPUT_TOKENS"
    MEDIAN_SCORE = "MEDIAN_SCORE"
    NEW_USERS = "NEW_USERS"
    OUTPUT_COST = "OUTPUT_COST"
    OUTPUT_TOKENS = "OUTPUT_TOKENS"
    P50_LATENCY = "P50_LATENCY"
    P90_LATENCY = "P90_LATENCY"
    P99_LATENCY = "P99_LATENCY"
    PASS_RATE = "PASS_RATE"
    RETENTION = "RETENTION"
    TOTAL_COST = "TOTAL_COST"
    TOTAL_TOKENS = "TOTAL_TOKENS"
    UNIQUE_END_USERS = "UNIQUE_END_USERS"
    UNIQUE_METADATA_VALUES = "UNIQUE_METADATA_VALUES"
    UNIQUE_THREADS = "UNIQUE_THREADS"
    UNIQUE_USERS = "UNIQUE_USERS"

enum WidgetAggregation {
  AVG_COST = "AVG_COST",
  AVG_COST_PER_USER = "AVG_COST_PER_USER",
  AVG_LATENCY = "AVG_LATENCY",
  AVG_RATING = "AVG_RATING",
  AVG_SCORE = "AVG_SCORE",
  AVG_VALUE = "AVG_VALUE",
  COUNT = "COUNT",
  ERROR_COUNT = "ERROR_COUNT",
  ERROR_RATE = "ERROR_RATE",
  FAILURE_RATE = "FAILURE_RATE",
  INPUT_COST = "INPUT_COST",
  INPUT_TOKENS = "INPUT_TOKENS",
  MEDIAN_SCORE = "MEDIAN_SCORE",
  NEW_USERS = "NEW_USERS",
  OUTPUT_COST = "OUTPUT_COST",
  OUTPUT_TOKENS = "OUTPUT_TOKENS",
  P50_LATENCY = "P50_LATENCY",
  P90_LATENCY = "P90_LATENCY",
  P99_LATENCY = "P99_LATENCY",
  PASS_RATE = "PASS_RATE",
  RETENTION = "RETENTION",
  TOTAL_COST = "TOTAL_COST",
  TOTAL_TOKENS = "TOTAL_TOKENS",
  UNIQUE_END_USERS = "UNIQUE_END_USERS",
  UNIQUE_METADATA_VALUES = "UNIQUE_METADATA_VALUES",
  UNIQUE_THREADS = "UNIQUE_THREADS",
  UNIQUE_USERS = "UNIQUE_USERS",
}

AVG_COST · AVG_COST_PER_USER · AVG_LATENCY · AVG_RATING · AVG_SCORE · AVG_VALUE · COUNT · ERROR_COUNT · ERROR_RATE · FAILURE_RATE · INPUT_COST · INPUT_TOKENS · MEDIAN_SCORE · NEW_USERS · OUTPUT_COST · OUTPUT_TOKENS · P50_LATENCY · P90_LATENCY · P99_LATENCY · PASS_RATE · RETENTION · TOTAL_COST · TOTAL_TOKENS · UNIQUE_END_USERS · UNIQUE_METADATA_VALUES · UNIQUE_THREADS · UNIQUE_USERS

WidgetBucketMode

How a widget's data is bucketed over the query time range. SERIES splits the range into one bucket per granularity interval; RANGE aggregates the whole range into a single bucket, as a BIG_NUMBER widget wants. Defaults to SERIES.

class WidgetBucketMode(Enum):
    SERIES = "SERIES"
    RANGE = "RANGE"

enum WidgetBucketMode {
  SERIES = "SERIES",
  RANGE = "RANGE",
}

SERIES · RANGE

WidgetData

A widget's computed data. Branch on kind to read it: Confident AI derives the shape from the widget's type and mode, so a DIMENSION_SERIES widget drawn as a TABLE returns TABLE data.

WidgetData = Union[
    WidgetBigNumberData,
    WidgetTimeSeriesData,
    WidgetDimensionData,
    WidgetTableData,
]

type WidgetData =
  | WidgetBigNumberData
  | WidgetTimeSeriesData
  | WidgetDimensionData
  | WidgetTableData;

A WidgetData is one of the shapes below. Send the fields of one of them, never a mix of both.

The whole query range aggregated to one figure per line, as a BIG_NUMBER widget draws it.

class WidgetBigNumberData:
    kind: Literal["BIG_NUMBER"]
    unit: Optional[WidgetUnit]
    values: List[WidgetScalarValue]

kindLiteral["BIG_NUMBER"]Required

Marks the result as a set of headline figures.

unitOptional[WidgetUnit]Required

The unit the values are measured in, or null when the widget's lines imply none.

See WidgetUnit.

valuesList[WidgetScalarValue]Required

One figure per line on the widget.

See WidgetScalarValue.

interface WidgetBigNumberData {
  kind: "BIG_NUMBER";
  unit: WidgetUnit | null;
  values: WidgetScalarValue[];
}

kind"BIG_NUMBER"Required

Marks the result as a set of headline figures.

unitWidgetUnit | nullRequired

The unit the values are measured in, or null when the widget's lines imply none.

See WidgetUnit.

valuesWidgetScalarValue[]Required

One figure per line on the widget.

See WidgetScalarValue.

Values bucketed over the query range, each point's x the start of its time bucket.

class WidgetTimeSeriesData:
    kind: Literal["TIME_SERIES"]
    unit: Optional[WidgetUnit]
    series: List[WidgetSeries]

kindLiteral["TIME_SERIES"]Required

Marks the result as series plotted against time.

unitOptional[WidgetUnit]Required

The unit the values are measured in, or null when the widget's lines imply none.

See WidgetUnit.

seriesList[WidgetSeries]Required

One series per line, or per dimension value when the widget breaks its single line down.

See WidgetSeries.

interface WidgetTimeSeriesData {
  kind: "TIME_SERIES";
  unit: WidgetUnit | null;
  series: WidgetSeries[];
}

kind"TIME_SERIES"Required

Marks the result as series plotted against time.

unitWidgetUnit | nullRequired

The unit the values are measured in, or null when the widget's lines imply none.

See WidgetUnit.

seriesWidgetSeries[]Required

One series per line, or per dimension value when the widget breaks its single line down.

See WidgetSeries.

The whole query range aggregated per dimension value, as a DIMENSION_SERIES widget draws it.

class WidgetDimensionData:
    kind: Literal["DIMENSION"]
    unit: Optional[WidgetUnit]
    series: List[WidgetSeries]

kindLiteral["DIMENSION"]Required

Marks the result as series plotted against a dimension.

unitOptional[WidgetUnit]Required

The unit the values are measured in, or null when the widget's lines imply none.

See WidgetUnit.

seriesList[WidgetSeries]Required

One series per line, each point's x a value of the widget's dimension.

See WidgetSeries.

interface WidgetDimensionData {
  kind: "DIMENSION";
  unit: WidgetUnit | null;
  series: WidgetSeries[];
}

kind"DIMENSION"Required

Marks the result as series plotted against a dimension.

unitWidgetUnit | nullRequired

The unit the values are measured in, or null when the widget's lines imply none.

See WidgetUnit.

seriesWidgetSeries[]Required

One series per line, each point's x a value of the widget's dimension.

See WidgetSeries.

The whole query range aggregated into a table, as a TABLE widget draws it.

class WidgetTableData:
    kind: Literal["TABLE"]
    columns: List[WidgetTableColumn]
    rows: List[Dict[str, Union[str, float]]]

kindLiteral["TABLE"]Required

Marks the result as columns and rows.

columnsList[WidgetTableColumn]Required

The table's columns: the widget's dimension first, under the key dimension, then one column per line.

See WidgetTableColumn.

rowsList[Dict[str, Union[str, float]]]Required

One row per dimension value. Each row holds its values under the key of the column they belong to, and a value is null where the row had nothing to aggregate.

Example: [{"dimension":"gpt-4o","Traces":128}]

interface WidgetTableData {
  kind: "TABLE";
  columns: WidgetTableColumn[];
  rows: (Record<string, string | number | null>)[];
}

kind"TABLE"Required

Marks the result as columns and rows.

columnsWidgetTableColumn[]Required

The table's columns: the widget's dimension first, under the key dimension, then one column per line.

See WidgetTableColumn.

rows(Record<string, string | number | null>)[]Required

One row per dimension value. Each row holds its values under the key of the column they belong to, and a value is null where the row had nothing to aggregate.

Example: [{"dimension":"gpt-4o","Traces":128}]

WidgetDataModel

The entity a widget line aggregates over. It decides which aggregations, filters and extraQueryParams the line accepts.

class WidgetDataModel(Enum):
    TRACE = "TRACE"
    SPAN = "SPAN"
    LLM_SPAN = "LLM_SPAN"
    AGENT_SPAN = "AGENT_SPAN"
    RETRIEVER_SPAN = "RETRIEVER_SPAN"
    TOOL_SPAN = "TOOL_SPAN"
    CUSTOM_SPAN = "CUSTOM_SPAN"
    THREAD = "THREAD"
    END_USER = "END_USER"
    METRIC_DATA = "METRIC_DATA"
    ANNOTATION = "ANNOTATION"
    CLASSIFICATION = "CLASSIFICATION"

enum WidgetDataModel {
  TRACE = "TRACE",
  SPAN = "SPAN",
  LLM_SPAN = "LLM_SPAN",
  AGENT_SPAN = "AGENT_SPAN",
  RETRIEVER_SPAN = "RETRIEVER_SPAN",
  TOOL_SPAN = "TOOL_SPAN",
  CUSTOM_SPAN = "CUSTOM_SPAN",
  THREAD = "THREAD",
  END_USER = "END_USER",
  METRIC_DATA = "METRIC_DATA",
  ANNOTATION = "ANNOTATION",
  CLASSIFICATION = "CLASSIFICATION",
}

TRACE · SPAN · LLM_SPAN · AGENT_SPAN · RETRIEVER_SPAN · TOOL_SPAN · CUSTOM_SPAN · THREAD · END_USER · METRIC_DATA · ANNOTATION · CLASSIFICATION

WidgetDimension

The property a widget breaks its data down by, one series or table row per distinct value.

class WidgetDimension(Enum):
    PROJECT = "project"
    TRACE_NAME = "trace_name"
    SPAN_NAME = "span_name"
    MODEL = "model"
    TYPE = "type"
    THREAD_ID = "thread_id"
    TEST_CASE_ID = "test_case_id"
    TEST_RUN_ID = "test_run_id"
    END_USER = "end_user"
    CUSTOMER = "customer"
    SOURCE = "source"
    ANNOTATOR = "annotator"
    NAME = "name"
    ERROR = "error"
    PROMPT_ALIAS = "prompt_alias"
    TAG = "tag"
    LABEL = "label"
    EVALUATION_MODEL = "evaluation_model"
    PROMPT_VERSION = "prompt_version"
    PROMPT_LABEL = "prompt_label"
    PROMPT_COMMIT_HASH = "prompt_commit_hash"
    METADATA = "metadata"
    HYPERPARAMETER = "hyperparameter"
    CLASSIFIER = "classifier"
    POLARITY = "polarity"
    CLASSIFIER_LABEL = "classifier_label"
    VERSION = "version"
    VALUE = "value"
    FAILURE_SUB_MODE = "failure_sub_mode"

enum WidgetDimension {
  PROJECT = "project",
  TRACE_NAME = "trace_name",
  SPAN_NAME = "span_name",
  MODEL = "model",
  TYPE = "type",
  THREAD_ID = "thread_id",
  TEST_CASE_ID = "test_case_id",
  TEST_RUN_ID = "test_run_id",
  END_USER = "end_user",
  CUSTOMER = "customer",
  SOURCE = "source",
  ANNOTATOR = "annotator",
  NAME = "name",
  ERROR = "error",
  PROMPT_ALIAS = "prompt_alias",
  TAG = "tag",
  LABEL = "label",
  EVALUATION_MODEL = "evaluation_model",
  PROMPT_VERSION = "prompt_version",
  PROMPT_LABEL = "prompt_label",
  PROMPT_COMMIT_HASH = "prompt_commit_hash",
  METADATA = "metadata",
  HYPERPARAMETER = "hyperparameter",
  CLASSIFIER = "classifier",
  POLARITY = "polarity",
  CLASSIFIER_LABEL = "classifier_label",
  VERSION = "version",
  VALUE = "value",
  FAILURE_SUB_MODE = "failure_sub_mode",
}

PROJECT · TRACE_NAME · SPAN_NAME · MODEL · TYPE · THREAD_ID · TEST_CASE_ID · TEST_RUN_ID · END_USER · CUSTOMER · SOURCE · ANNOTATOR · NAME · ERROR · PROMPT_ALIAS · TAG · LABEL · EVALUATION_MODEL · PROMPT_VERSION · PROMPT_LABEL · PROMPT_COMMIT_HASH · METADATA · HYPERPARAMETER · CLASSIFIER · POLARITY · CLASSIFIER_LABEL · VERSION · VALUE · FAILURE_SUB_MODE

WidgetGranularity

The size of each bucket in computed widget data. Left unset, Confident AI picks one from the length of the query range.

class WidgetGranularity(Enum):
    THIRTY_MINUTES = "thirty_minutes"
    HOUR = "hour"
    DAY = "day"
    WEEK = "week"
    MONTH = "month"

enum WidgetGranularity {
  THIRTY_MINUTES = "thirty_minutes",
  HOUR = "hour",
  DAY = "day",
  WEEK = "week",
  MONTH = "month",
}

THIRTY_MINUTES · HOUR · DAY · WEEK · MONTH

WidgetLayout

A widget's position and size on the dashboard's 12-column grid. Omit it when creating a widget and Confident AI packs it into the first free space.

class WidgetLayout:
    x: float
    y: float
    w: float
    h: float

xfloatRequired

The widget's left edge, as a column index on the 12-column grid.

Example: 0

yfloatRequired

The widget's top edge, as a row index on the grid.

Example: 0

wfloatRequired

The widget's width in grid columns.

Example: 6

hfloatRequired

The widget's height in grid rows.

Example: 2

interface WidgetLayout {
  x: number;
  y: number;
  w: number;
  h: number;
}

xnumberRequired

The widget's left edge, as a column index on the 12-column grid.

Example: 0

ynumberRequired

The widget's top edge, as a row index on the grid.

Example: 0

wnumberRequired

The widget's width in grid columns.

Example: 6

hnumberRequired

The widget's height in grid rows.

Example: 2

WidgetLine

One series plotted on a widget.

class WidgetLine:
    id: str
    name: str
    color: WidgetLineColor
    data_model: Optional[WidgetDataModel] = Field(alias="dataModel")
    aggregation: Optional[WidgetAggregation]
    filters: Optional[FilterSet]
    extra_query_params: Optional[WidgetLineExtraQueryParams] = Field(alias="extraQueryParams")

idstrRequired

The id of the line, generated by Confident AI.

Example: "<LINE-ID>"

namestrRequired

The name the line is labelled with in the legend.

Example: "Traces"

colorWidgetLineColorRequired

See WidgetLineColor.

data_modelOptional[WidgetDataModel]Required

The entity the line aggregates over, or null when the line has none and so plots nothing.

See WidgetDataModel.

aggregationOptional[WidgetAggregation]Required

The aggregation the line computes, or null when the line has none.

See WidgetAggregation.

filtersOptional[FilterSet]Required

The filters an entity must match to be counted by this line, or null when the line counts everything.

See FilterSet.

extra_query_paramsOptional[WidgetLineExtraQueryParams]Required

The line's advanced query parameters, or null when it has none.

See WidgetLineExtraQueryParams.

interface WidgetLine {
  id: string;
  name: string;
  color: WidgetLineColor;
  dataModel: WidgetDataModel | null;
  aggregation: WidgetAggregation | null;
  filters: FilterSet | null;
  extraQueryParams: WidgetLineExtraQueryParams | null;
}

idstringRequired

The id of the line, generated by Confident AI.

Example: "<LINE-ID>"

namestringRequired

The name the line is labelled with in the legend.

Example: "Traces"

colorWidgetLineColorRequired

See WidgetLineColor.

dataModelWidgetDataModel | nullRequired

The entity the line aggregates over, or null when the line has none and so plots nothing.

See WidgetDataModel.

aggregationWidgetAggregation | nullRequired

The aggregation the line computes, or null when the line has none.

See WidgetAggregation.

filtersFilterSet | nullRequired

The filters an entity must match to be counted by this line, or null when the line counts everything.

See FilterSet.

extraQueryParamsWidgetLineExtraQueryParams | nullRequired

The line's advanced query parameters, or null when it has none.

See WidgetLineExtraQueryParams.

WidgetLineColor

The colour a line is drawn in, from the Confident AI palette. A line you create without one is assigned the next colour in the palette.

class WidgetLineColor(Enum):
    AMBER = "AMBER"
    VIOLET = "VIOLET"
    EMERALD = "EMERALD"
    BLUE = "BLUE"
    PINK = "PINK"
    CYAN = "CYAN"
    ROSE = "ROSE"
    LIME = "LIME"
    TEAL = "TEAL"
    ORANGE = "ORANGE"

enum WidgetLineColor {
  AMBER = "AMBER",
  VIOLET = "VIOLET",
  EMERALD = "EMERALD",
  BLUE = "BLUE",
  PINK = "PINK",
  CYAN = "CYAN",
  ROSE = "ROSE",
  LIME = "LIME",
  TEAL = "TEAL",
  ORANGE = "ORANGE",
}

AMBER · VIOLET · EMERALD · BLUE · PINK · CYAN · ROSE · LIME · TEAL · ORANGE

WidgetLineConfig

One series to plot on a widget: what to aggregate, how to aggregate it, and over which entities.

class WidgetLineConfig:
    name: str
    color: Optional[WidgetLineColor] = None
    data_model: Optional[WidgetDataModel] = Field(default=None, alias="dataModel")
    aggregation: Optional[WidgetAggregation] = None
    filters: Optional[FilterSet] = None
    extra_query_params: Optional[WidgetLineExtraQueryParams] = Field(default=None, alias="extraQueryParams")

namestrRequired

The name the line is labelled with in the legend.

Example: "Traces"

colorOptional[WidgetLineColor]

The colour to draw the line in. Omit it, or send null, to take the next colour in the palette.

See WidgetLineColor.

Example: "BLUE"

data_modelOptional[WidgetDataModel]

The entity the line aggregates over. Required whenever aggregation is set; a line without one plots nothing.

See WidgetDataModel.

Example: "TRACE"

aggregationOptional[WidgetAggregation]

The aggregation the line computes over dataModel. Must be one of the tokens that data model accepts.

See WidgetAggregation.

Example: "COUNT"

filtersOptional[FilterSet]

The filters an entity must match to be counted by this line. Send null, or omit it, to aggregate over everything the data model holds.

See FilterSet.

extra_query_paramsOptional[WidgetLineExtraQueryParams]

Advanced query parameters for the line's data model. Send null, or omit it, when the data model needs none.

See WidgetLineExtraQueryParams.

Example: {"metricMetadataKey":"tokenCount"}

interface WidgetLineConfig {
  name: string;
  color?: WidgetLineColor | null;
  dataModel?: WidgetDataModel | null;
  aggregation?: WidgetAggregation | null;
  filters?: FilterSet | null;
  extraQueryParams?: WidgetLineExtraQueryParams | null;
}

namestringRequired

The name the line is labelled with in the legend.

Example: "Traces"

colorWidgetLineColor | null

The colour to draw the line in. Omit it, or send null, to take the next colour in the palette.

See WidgetLineColor.

Example: "BLUE"

dataModelWidgetDataModel | null

The entity the line aggregates over. Required whenever aggregation is set; a line without one plots nothing.

See WidgetDataModel.

Example: "TRACE"

aggregationWidgetAggregation | null

The aggregation the line computes over dataModel. Must be one of the tokens that data model accepts.

See WidgetAggregation.

Example: "COUNT"

filtersFilterSet | null

The filters an entity must match to be counted by this line. Send null, or omit it, to aggregate over everything the data model holds.

See FilterSet.

extraQueryParamsWidgetLineExtraQueryParams | null

Advanced query parameters for the line's data model. Send null, or omit it, when the data model needs none.

See WidgetLineExtraQueryParams.

Example: {"metricMetadataKey":"tokenCount"}

WidgetLineExtraQueryParams

Advanced per-line query parameters, whose recognised keys depend on the line's dataModel. spanType restricts a SPAN line to one span type; metricMetadataKey names the metadata field a span, trace or thread line aggregates; category and metricName pick out the metric a METRIC_DATA line reads; dataType and source say which annotations an ANNOTATION line counts. Unrecognised keys are ignored, and most lines send none of these.

WidgetMode

How a widget aggregates its lines. TIME_SERIES plots each configured line over time; DIMENSION_SERIES takes a single metric and splits it into one series per value of the widget's dimension. This is the widget's saved configuration — the shape of a query response is given by kind on the result.

class WidgetMode(Enum):
    TIME_SERIES = "TIME_SERIES"
    DIMENSION_SERIES = "DIMENSION_SERIES"

enum WidgetMode {
  TIME_SERIES = "TIME_SERIES",
  DIMENSION_SERIES = "DIMENSION_SERIES",
}

TIME_SERIES · DIMENSION_SERIES

WidgetQueryResult

One widget's computed data, with the widget it came from.

class WidgetQueryResult:
    widget_id: str = Field(alias="widgetId")
    type: Optional[WidgetType]
    mode: Optional[WidgetMode]
    data: WidgetData

widget_idstrRequired

The id of the widget this result was computed for.

Example: "<WIDGET-ID>"

typeOptional[WidgetType]Required

The widget's visualization, echoed from its configuration. It says how to draw the result, not how to read it — branch on data.kind for that.

See WidgetType.

modeOptional[WidgetMode]Required

The widget's aggregation mode, echoed from its configuration. Branch on data.kind rather than on this when reading the result.

See WidgetMode.

dataWidgetDataRequired

See WidgetData.

interface WidgetQueryResult {
  widgetId: string;
  type: WidgetType | null;
  mode: WidgetMode | null;
  data: WidgetData;
}

widgetIdstringRequired

The id of the widget this result was computed for.

Example: "<WIDGET-ID>"

typeWidgetType | nullRequired

The widget's visualization, echoed from its configuration. It says how to draw the result, not how to read it — branch on data.kind for that.

See WidgetType.

modeWidgetMode | nullRequired

The widget's aggregation mode, echoed from its configuration. Branch on data.kind rather than on this when reading the result.

See WidgetMode.

dataWidgetDataRequired

See WidgetData.

WidgetRef

A reference to a widget by its id.

class WidgetRef:
    id: str

idstrRequired

The id of the widget, generated by Confident AI.

Example: "<WIDGET-ID>"

interface WidgetRef {
  id: string;
}

idstringRequired

The id of the widget, generated by Confident AI.

Example: "<WIDGET-ID>"

WidgetScalarValue

One headline figure of a big number widget.

class WidgetScalarValue:
    key: str
    name: str
    color: WidgetLineColor
    line_id: Optional[str] = Field(default=None, alias="lineId")
    value: Optional[float]

keystrRequired

A key that identifies this series within the result, unique across the result and stable between queries. Use it as a render key, or to line results up across queries.

Example: "Traces"

namestrRequired

The label to show for the series.

Example: "Traces"

colorWidgetLineColorRequired

See WidgetLineColor.

line_idOptional[str]

The id of the widget line this series was computed from, when one line produced it.

Example: "<LINE-ID>"

valueOptional[float]Required

The aggregated value over the whole query range, or null when there was nothing to aggregate.

Example: 3814

interface WidgetScalarValue {
  key: string;
  name: string;
  color: WidgetLineColor;
  lineId?: string;
  value: number | null;
}

keystringRequired

A key that identifies this series within the result, unique across the result and stable between queries. Use it as a render key, or to line results up across queries.

Example: "Traces"

namestringRequired

The label to show for the series.

Example: "Traces"

colorWidgetLineColorRequired

See WidgetLineColor.

lineIdstring

The id of the widget line this series was computed from, when one line produced it.

Example: "<LINE-ID>"

valuenumber | nullRequired

The aggregated value over the whole query range, or null when there was nothing to aggregate.

Example: 3814

WidgetSeries

One plotted series of a time series or dimension breakdown.

class WidgetSeries:
    key: str
    name: str
    color: WidgetLineColor
    line_id: Optional[str] = Field(default=None, alias="lineId")
    points: List[WidgetSeriesPoint]

keystrRequired

A key that identifies this series within the result, unique across the result and stable between queries. Use it as a render key, or to line results up across queries.

Example: "Traces"

namestrRequired

The label to show for the series.

Example: "Traces"

colorWidgetLineColorRequired

See WidgetLineColor.

line_idOptional[str]

The id of the widget line this series was computed from, when one line produced it.

Example: "<LINE-ID>"

pointsList[WidgetSeriesPoint]Required

The series' points, ordered by time for TIME_SERIES data and by the order the dimension values were ranked in for DIMENSION data.

See WidgetSeriesPoint.

interface WidgetSeries {
  key: string;
  name: string;
  color: WidgetLineColor;
  lineId?: string;
  points: WidgetSeriesPoint[];
}

keystringRequired

A key that identifies this series within the result, unique across the result and stable between queries. Use it as a render key, or to line results up across queries.

Example: "Traces"

namestringRequired

The label to show for the series.

Example: "Traces"

colorWidgetLineColorRequired

See WidgetLineColor.

lineIdstring

The id of the widget line this series was computed from, when one line produced it.

Example: "<LINE-ID>"

pointsWidgetSeriesPoint[]Required

The series' points, ordered by time for TIME_SERIES data and by the order the dimension values were ranked in for DIMENSION data.

See WidgetSeriesPoint.

WidgetSeriesPoint

One plotted point of a series.

class WidgetSeriesPoint:
    x: str
    y: Optional[float]

xstrRequired

The point's position along the x axis: the start of the time bucket for TIME_SERIES data, the dimension value for DIMENSION data.

Example: "2025-01-15T00:00:00+00:00"

yOptional[float]Required

The aggregated value at this point, or null when the bucket held nothing to aggregate.

Example: 128

interface WidgetSeriesPoint {
  x: string;
  y: number | null;
}

xstringRequired

The point's position along the x axis: the start of the time bucket for TIME_SERIES data, the dimension value for DIMENSION data.

Example: "2025-01-15T00:00:00+00:00"

ynumber | nullRequired

The aggregated value at this point, or null when the bucket held nothing to aggregate.

Example: 128

WidgetTableColumn

One column of a table widget's result.

class WidgetTableColumn:
    key: str
    label: str

keystrRequired

The key each row holds this column's value under.

Example: "Traces"

labelstrRequired

The label to show in the column header.

Example: "Traces"

interface WidgetTableColumn {
  key: string;
  label: string;
}

keystringRequired

The key each row holds this column's value under.

Example: "Traces"

labelstringRequired

The label to show in the column header.

Example: "Traces"

WidgetTopK

Caps a dimension breakdown at the most interesting values, so a dimension with thousands of values still plots.

class WidgetTopK:
    limit: Optional[int] = None
    order_by: Optional[Literal["count", "avg_latency", "p50_latency", "p90_latency", "p99_latency", "error_rate", "pass_rate", "failure_rate", "input_cost", "output_cost", "total_cost", "avg_cost", "input_tokens", "output_tokens", "total_tokens", "count_distinct_endUserId", "count_distinct_threadId", "count_distinct_model", "count_distinct_projectId", "count_distinct_error", "count_distinct_metadata", "error_count", "pass_count", "avg_score", "stddev_score", "median_score", "avg_rating", "avg_value", "score_histogram", "created_at", "start_time", "dimension"]] = Field(default=None, alias="orderBy")
    direction: Optional[Literal["asc", "desc"]] = None

limitOptional[int]

The number of series or rows to keep, taking the highest or lowest by orderBy. Defaults to 10.

Example: 10

order_byOptional[Literal["count", "avg_latency", "p50_latency", "p90_latency", "p99_latency", "error_rate", "pass_rate", "failure_rate", "input_cost", "output_cost", "total_cost", "avg_cost", "input_tokens", "output_tokens", "total_tokens", "count_distinct_endUserId", "count_distinct_threadId", "count_distinct_model", "count_distinct_projectId", "count_distinct_error", "count_distinct_metadata", "error_count", "pass_count", "avg_score", "stddev_score", "median_score", "avg_rating", "avg_value", "score_histogram", "created_at", "start_time", "dimension"]]

The metric or column the dimension values are ranked by. Defaults to count.

Example: "p90_latency"

directionOptional[Literal["asc", "desc"]]

Whether to keep the highest ranked values or the lowest. Defaults to desc.

Example: "desc"

interface WidgetTopK {
  limit?: number;
  orderBy?: "count" | "avg_latency" | "p50_latency" | "p90_latency" | "p99_latency" | "error_rate" | "pass_rate" | "failure_rate" | "input_cost" | "output_cost" | "total_cost" | "avg_cost" | "input_tokens" | "output_tokens" | "total_tokens" | "count_distinct_endUserId" | "count_distinct_threadId" | "count_distinct_model" | "count_distinct_projectId" | "count_distinct_error" | "count_distinct_metadata" | "error_count" | "pass_count" | "avg_score" | "stddev_score" | "median_score" | "avg_rating" | "avg_value" | "score_histogram" | "created_at" | "start_time" | "dimension";
  direction?: "asc" | "desc";
}

limitnumber

The number of series or rows to keep, taking the highest or lowest by orderBy. Defaults to 10.

Example: 10

The metric or column the dimension values are ranked by. Defaults to count.

Example: "p90_latency"

direction"asc" | "desc"

Whether to keep the highest ranked values or the lowest. Defaults to desc.

Example: "desc"

WidgetType

The visualization a widget is drawn as. It is how the widget is displayed and does not by itself decide the shape of a query response — a TABLE widget returns tabular data whatever its mode is.

class WidgetType(Enum):
    LINE = "LINE"
    AREA = "AREA"
    BAR = "BAR"
    STACKED_BAR = "STACKED_BAR"
    GROUPED_BAR = "GROUPED_BAR"
    TABLE = "TABLE"
    BIG_NUMBER = "BIG_NUMBER"

enum WidgetType {
  LINE = "LINE",
  AREA = "AREA",
  BAR = "BAR",
  STACKED_BAR = "STACKED_BAR",
  GROUPED_BAR = "GROUPED_BAR",
  TABLE = "TABLE",
  BIG_NUMBER = "BIG_NUMBER",
}

LINE · AREA · BAR · STACKED_BAR · GROUPED_BAR · TABLE · BIG_NUMBER

WidgetUnit

The unit a widget's values are measured in.

class WidgetUnit(Enum):
    COUNT = "COUNT"
    PERCENT = "PERCENT"
    SCORE = "SCORE"
    SECONDS = "SECONDS"
    USD = "USD"
    MILLISECONDS = "MILLISECONDS"

enum WidgetUnit {
  COUNT = "COUNT",
  PERCENT = "PERCENT",
  SCORE = "SCORE",
  SECONDS = "SECONDS",
  USD = "USD",
  MILLISECONDS = "MILLISECONDS",
}

COUNT · PERCENT · SCORE · SECONDS · USD · MILLISECONDS

Building a production pipeline?Design a scalable API workflow for evals, datasets, traces, and promptsTalk to an engineer

Last updated on September 30, 2026

Built byConfident AI

Overview

Methods

Create Widget

Parameters

Parameters

Returns

Update Widget

Parameters

Parameters

Returns

Delete Widget

Parameters

Parameters

Returns

Query Widget

Parameters

Parameters

Returns

Types

FilterSet

Widget

WidgetAggregation

WidgetBucketMode

WidgetData

WidgetDataModel

WidgetDimension

WidgetGranularity

WidgetLayout

WidgetLine

WidgetLineColor

WidgetLineConfig

WidgetLineExtraQueryParams

WidgetMode

WidgetQueryResult

WidgetRef

WidgetScalarValue

WidgetSeries

WidgetSeriesPoint

WidgetTableColumn

WidgetTopK

WidgetType

WidgetUnit