Skip to content

Create KPI dashboard

POST
/api/v1/analytics/kpi-dashboards

Create a custom KPI dashboard. Starter plan limited to 10 dashboards.

Authorizations

Request Body required

Schema for creating a new custom KPI dashboard.

Attributes: name: Dashboard name (max 120 chars). metric_ids: Non-empty list of metric_id strings from the catalog. filters: Optional dict of filter key-value pairs. date_range_preset: Period preset (default “30d”). chart_config: Optional chart rendering configuration. sort_order: Display ordering (default 0).

object
chart_config
object
key
additional properties
any
date_range_preset
string
default: 30d
filters
object
key
additional properties
any
metric_ids
required
Array<string>
name
required
string
<= 120 characters
sort_order
integer

Responses

201

Successful Response

object
key
additional properties
any

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string