Get high level information about usage of Unleash.

GET /api/admin/dashboard/executive

Get executive summary

Request

Responses

executiveSummarySchema

application/json

Schema
Example (from schema)

Schema

users objectrequired
High level user count statistics
total number required
The number of actual Unleash users
active number required
The number of active Unleash users who have user Unleash in the past 60 days
inactive number required
The number of inactive Unleash users who have not used Unleash in the past 60 days.
flags objectrequired
High level flag count statistics
total number required
The number of non-archived flags
userTrends object[]required
How number of users changed over time
Array [
date date-time required
A UTC date when the stats were captured. Time is the very end of a given day.
total number required
The number of actual Unleash users on a particular day
active number required
The number of active Unleash users on a particular day
inactive number required
The number of inactive Unleash users on a particular day
]
flagTrends object[]required
How number of flags changed over time
Array [
date date-time required
A UTC date when the stats were captured. Time is the very end of a given day.
total number required
The number of all flags on a particular day
active number required
The number of active flags on a particular day
stale number required
The number of user marked stale flags on a particular day
potentiallyStale number required
The number of time calculated potentially stale flags on a particular day
]
projectFlagTrends object[]required
How number of flags per project changed over time
Array [
project string required
Project id of the project the flag trends belong to
health number
An indicator of the project's health on a scale from 0 to 100
timeToProduction number
The average time from when a feature was created to when it was enabled in the "production" environment during the current window
date date-time required
A UTC date when the stats were captured. Time is the very end of a given day.
total number required
The number of all flags on a particular day
active number required
The number of active flags on a particular day
stale number required
The number of user marked stale flags on a particular day
potentiallyStale number required
The number of time calculated potentially stale flags on a particular day
]

{
  "users": {
    "total": 100,
    "active": 98,
    "inactive": 2
  },
  "flags": {
    "total": 100
  },
  "userTrends": [
    {
      "date": "2024-01-12T23:59:59.999Z",
      "total": 100,
      "active": 98,
      "inactive": 2
    }
  ],
  "flagTrends": [
    {
      "date": "2024-01-12T23:59:59.999Z",
      "total": 100,
      "active": 98,
      "stale": 0,
      "potentiallyStale": 2
    }
  ],
  "projectFlagTrends": [
    {
      "project": "default",
      "health": 50,
      "timeToProduction": 10,
      "date": "2024-01-12T23:59:59.999Z",
      "total": 100,
      "active": 98,
      "stale": 0,
      "potentiallyStale": 2
    }
  ]
}

Get high level information about usage of Unleash.

Request​

Request