Success metrics dashboard

GET

/api/v1/chairman/metrics

const url = 'https://api.ultimateteam.ai/api/v1/chairman/metrics';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/chairman/metrics \
  --header 'X-API-Key: <X-API-Key>'

North star metric, leading indicators, monthly targets vs actuals.

Authorizations

ApiKeyAuth

Responses

200

Successful Response

application/json

SuccessMetricsResponse

Wrapper for GET /chairman/metrics.

Attributes: data: The success metrics payload.

object

data

required

SuccessMetricsView

Chairman’s success metrics dashboard.

Attributes: north_star: The north star metric description. north_star_value: Current north star metric value. leading_indicators: List of leading indicators. monthly_targets: Monthly targets with actuals.

object

leading_indicators

Leading Indicators

Array<object>

LeadingIndicator

A single leading indicator with current value.

Attributes: name: Indicator description. current_value: Current measured value. target_value: Target value (if defined). unit: Unit of measurement.

object

current_value

Current Value

number

name

required

Name

string

target_value

Any of:

number
null

number

unit

Unit

string

monthly_targets

Monthly Targets

Array<object>

MonthlyTarget

A monthly target from the success metrics plan.

Attributes: month: Target month number. users: Target total users. paying: Target paying customers. mrr: Target MRR. milestone: Description of the milestone. actual_users: Actual users (if known). actual_paying: Actual paying customers (if known). actual_mrr: Actual MRR (if known).

object

actual_mrr

Any of:

number
null

number

actual_paying

Any of:

integer
null

integer

actual_users

Any of:

integer
null

integer

milestone

Milestone

string

month

required

Month

integer

mrr

Mrr

number

paying

Paying

integer

users

Users

integer

north_star

North Star

string

north_star_value

North Star Value

integer

Example

{
  "data": {
    "leading_indicators": [
      {
        "current_value": 0,
        "unit": ""
      }
    ],
    "monthly_targets": [
      {
        "milestone": "",
        "mrr": 0,
        "paying": 0,
        "users": 0
      }
    ],
    "north_star": "",
    "north_star_value": 0
  }
}