Skip to content
UltimateTeam.ai Docs

Create KPI dashboard

POST
/api/v1/analytics/kpi-dashboards
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/analytics/kpi-dashboards \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "chart_config": {}, "date_range_preset": "30d", "filters": {}, "metric_ids": [ "example" ], "name": "example", "sort_order": 0 }'

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

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CustomKpiDashboardCreate

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
Chart Config
object
key
additional properties
any
date_range_preset
Date Range Preset
string
default: 30d
filters
Filters
object
key
additional properties
any
metric_ids
required
Metric Ids
Array<string>
name
required
Name
string
<= 120 characters
sort_order
Sort Order
integer
0

Responses

Section titled “ Responses ”

201

Section titled “201”

Successful Response

Media typeapplication/json
Response Create Kpi Dashboard Api V1 Analytics Kpi Dashboards Post
object
key
additional properties
any
Examplegenerated
{}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}