Preview an ad-hoc metric selection

POST

/api/v1/analytics/kpi-dashboards/preview

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

• Production
• Local development

Execute the given catalog metrics without saving a dashboard.

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

KpiPreviewRequest

Ad-hoc preview request for an unsaved metric selection.

Attributes: metric_ids: Catalog metric_ids to execute. date_range_preset: One of 7d, 30d, 90d.

object

date_range_preset

Date Range Preset

string

default: 30d

metric_ids

required

Metric Ids

Array<string>

>= 1 items <= 20 items

Responses

200

Successful Response

Media typeapplication/json

Response Preview Kpi Selection Api V1 Analytics Kpi Dashboards Preview Post

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"
    }
  ]
}