Update KPI dashboard

PUT

/api/v1/analytics/kpi-dashboards/{dashboard_id}

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

• Production
• Local development

Update a custom KPI dashboard.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

dashboard_id

required

Dashboard Id

string

Request Body^required

Media typeapplication/json

CustomKpiDashboardUpdate

Schema for updating an existing custom KPI dashboard.

All fields are optional; only provided fields are updated.

object

chart_config

Any of:

object

object

key

additional properties

any

null

null

date_range_preset

Any of:

string

string

null

null

filters

Any of:

object

object

key

additional properties

any

null

null

metric_ids

Any of:

Array<string>

Array<string>

null

null

name

Any of:

string

string

<= 120 characters

null

null

sort_order

Any of:

integer

integer

null

null

Example^generated

{
  "chart_config": {},
  "date_range_preset": "example",
  "filters": {},
  "metric_ids": [
    "example"
  ],
  "name": "example",
  "sort_order": 1
}

Responses

200

Successful Response

Media typeapplication/json

Response Update Kpi Dashboard Api V1 Analytics Kpi Dashboards Dashboard Id Put

object

key

additional properties

any

Example^generated

{}

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

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}