Create Dashboard
POSThttps://api.confident-ai.com/v1/dashboards
Creates a dashboard, optionally with starter widget configurations, and returns the id of the created dashboard. Use the dashboard detail endpoint for its full configuration, or a query endpoint for computed widget data.
curl -X POST "https://api.confident-ai.com/v1/dashboards" \
-H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
-H "Content-Type: application/json" \
-d '{
"name": "Production Overview"
}'{
"success": true,
"data": {
"id": "DASHBOARD-ID"
},
"deprecated": false
}Headers
CONFIDENT_API_KEYstringRequiredThe API key of your Confident AI project.
Request body
namestringRequiredThe dashboard's name.
descriptionstringAn optional description of the dashboard.
privatebooleanWhether the dashboard is private. Defaults to false.
widgetslist of objectsOptional starter widgets to create alongside the dashboard.
Show 12 propertiesHide 12 properties
namestringRequiredThe widget's name.
descriptionstringAn optional description of the widget.
typeenumThe visualization type of a widget.
Show 6 enum valuesHide 6 enum values
LINEAREABARSTACKED_BARTABLEBIG_NUMBER
unitenumThe unit a widget's values are measured in.
Show 6 enum valuesHide 6 enum values
COUNTPERCENTSCORESECONDSUSDMILLISECONDS
modeenumHow a widget aggregates its lines.
TIME_SERIESplots each configured line over time;DIMENSION_SERIEStakes a single metric and splits it into one series per value of the widget's dimension. This is the widget's saved configuration — it does not by itself describe the shape of a query response (usekindon the query result for that).Show 2 enum valuesHide 2 enum values
TIME_SERIESDIMENSION_SERIES
bucketModeenumHow a widget's data is bucketed over the query time range.
SERIESsplits the range into one bucket pergranularityinterval (a time series);RANGEaggregates the whole range into a single bucket (one total, as used by BIG_NUMBER widgets). Defaults toSERIESwhen omitted.Show 2 enum valuesHide 2 enum values
SERIESRANGE
dimensionenumThe dimension a widget breaks down by when mode is DIMENSION_SERIES.
Show 22 enum valuesHide 22 enum values
projecttrace_namespan_namemodeltypethread_idtest_case_idtest_run_idend_usersourceannotatornameerrorprompt_aliastaglabelevaluation_modelprompt_versionprompt_labelprompt_commit_hashmetadataclassifier
topKobjectLimits a dimension breakdown to the top K series.
Show 3 propertiesHide 3 properties
limitintegerMaximum number of series to return. Defaults to 10.
orderByenumThe metric or column to order topK results by.
Show 28 enum valuesHide 28 enum values
countavg_latencyp50_latencyp90_latencyp99_latencyerror_ratepass_ratefailure_rateinput_costoutput_costtotal_costavg_costinput_tokensoutput_tokenstotal_tokenscount_distinct_endUserIdcount_distinct_threadIdcount_distinct_modelcount_distinct_projectIdcount_distinct_errorcount_distinct_metadataerror_countavg_scorestddev_scoreavg_ratingcreated_atstart_timedimension
directionenumThe sort direction for topK results.
Show 2 enum valuesHide 2 enum values
ascdesc
startTimestringThe start of the widget's custom time range, if set.
endTimestringThe end of the widget's custom time range, if set.
layoutobjectA widget's position on the dashboard grid.
Show 4 propertiesHide 4 properties
xnumberThe widget's left edge as a column index on the 12-column grid.
ynumberThe widget's top edge as a row index on the grid.
wnumberThe widget's width in grid columns.
hnumberThe widget's height in grid rows.
lineslist of objectsThe series to show in the widget.
Show 6 propertiesHide 6 properties
namestringRequiredThe line's name.
colorenumThe color of a line. If omitted or unrecognized, a color is auto-assigned from the palette.
Show 10 enum valuesHide 10 enum values
AMBERVIOLETEMERALDBLUEPINKCYANROSELIMETEALORANGE
dataModelenumThe entity a line aggregates over.
Show 11 enum valuesHide 11 enum values
TRACESPANLLM_SPANAGENT_SPANRETRIEVER_SPANTOOL_SPANCUSTOM_SPANTHREADEND_USERMETRIC_DATAANNOTATION
aggregationenumThe aggregation applied to a line. The set of valid values depends on the line's dataModel.
Show 25 enum valuesHide 25 enum values
COUNTERROR_RATEPASS_RATEUNIQUE_END_USERSUNIQUE_THREADSUNIQUE_USERSUNIQUE_METADATA_VALUESAVG_LATENCYP50_LATENCYP90_LATENCYP99_LATENCYTOTAL_COSTAVG_COSTINPUT_COSTOUTPUT_COSTAVG_COST_PER_USERINPUT_TOKENSOUTPUT_TOKENSTOTAL_TOKENSERROR_COUNTNEW_USERSRETENTIONAVG_SCOREFAILURE_RATEAVG_RATING
filtersobjectA set of filter groups combined by a top-level operator.
Show 2 propertiesHide 2 properties
operatorenumRequiredHow filters or groups are combined.
Show 2 enum valuesHide 2 enum values
ANDOR
groupslist of objectsRequiredThe filter groups.
Show 2 propertiesHide 2 properties
operatorenumRequiredHow filters or groups are combined.
Show 2 enum valuesHide 2 enum values
ANDOR
filterslist of objectsRequiredThe filter rows in this group.
Show 4 propertiesHide 4 properties
categorystringRequiredThe property a filter row matches on (e.g. "Name", "User Id", "Model", "Metadata"). The set of valid values depends on the line's dataModel.
conditionenumRequiredThe comparison a filter row applies. Valid conditions depend on the category.
Show 18 enum valuesHide 18 enum values
IsIs notIs equal toDoes not equalIs less thanIs equal or less thanIs greater thanIs equal or greater thanHasHas notContainsContains onlyDoes not containHas increased by more thanHas increased by less thanHas decreased by more thanHas decreased by less thanHas changed from
valuestring | number | list of stringsRequiredThe value to match against.
keystringThe property key. Auto-populated from category when omitted; required for Metadata, Metric, and Classifier filters.
extraQueryParamsobjectAdvanced, per-line query parameters. Which keys take effect depends on the line's
dataModel, and unrecognized keys are ignored. All values are strings. Most lines leave thisnull.Show 6 propertiesHide 6 properties
spanTypeenumFor a
SPANline, restricts aggregation to a single span type. Not needed for the typed span models (LLM_SPAN,AGENT_SPAN,RETRIEVER_SPAN,TOOL_SPAN,CUSTOM_SPAN), which already imply their span type.Show 5 enum valuesHide 5 enum values
LLMAGENTRETRIEVERTOOLCUSTOM
metricMetadataKeystringFor span (
SPAN,LLM_SPAN,AGENT_SPAN,RETRIEVER_SPAN,TOOL_SPAN,CUSTOM_SPAN),TRACE, andTHREADlines, the metadata field key whose numeric value is aggregated.categoryenumFor a
METRIC_DATAline, the entity category the metric is attached to.Show 11 enum valuesHide 11 enum values
SINGLE_TURNMULTI_TURNTEST_RUNTRACESPANLLM_SPANAGENT_SPANRETRIEVER_SPANTOOL_SPANCUSTOM_SPANTHREAD
metricNamestringFor a
METRIC_DATAline, the name of the metric to aggregate.dataTypeenumFor an
ANNOTATIONline, which annotated entity type to aggregate over.Show 3 enum valuesHide 3 enum values
TracesSpansThreads
sourceenumFor an
ANNOTATIONline, whether to aggregate annotations left by end users or by reviewers.Show 2 enum valuesHide 2 enum values
UserReviewer
Response
The id of the created dashboard.
successbooleanIndicates if the request was successful.
dataobjectThe id of the affected dashboard or widget.
Show 1 propertyHide 1 property
idstringThe id of the affected dashboard or widget.
deprecatedbooleanIndicates if this endpoint is deprecated.