Get instance information

GET 
<your-unleash-url>/api/admin/dashboard/executive

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Gets high level information about the usage of this Unleash instance, including user, project, and flag information. This endpoint is deprecated and will be removed in a future minor version. Please use /api/admin/insights instead.

Responses

200

instanceInsightsSchema

application/json

Schema

Schema

userTrends object[]required
How number of users changed over time
Array [
datedate-timerequired
A UTC date when the stats were captured. Time is the very end of a given day.
Example: 2024-01-12T23:59:59.999Z
totalnumberrequired
The number of actual Unleash users on a particular day
Example: 100
activenumberrequired
The number of active Unleash users on a particular day
Example: 98
inactivenumberrequired
The number of inactive Unleash users on a particular day
Example: 2
]
flagTrends object[]required
How number of flags changed over time
Array [
datedate-timerequired
A UTC date when the stats were captured. Time is the very end of a given day.
Example: 2024-01-12T23:59:59.999Z
totalnumberrequired
The number of all flags on a particular day
Example: 100
activenumberrequired
The number of active flags on a particular day
Example: 98
stalenumberrequired
The number of user marked stale flags on a particular day
Example: 0
potentiallyStalenumberrequired
The number of time calculated potentially stale flags on a particular day
Example: 2
]
projectFlagTrends object[]required
How number of flags per project changed over time
Array [
weekstringrequired
Year and week in a given year for which the stats were calculated
Example: 2024-40
projectstringrequired
Project id of the project the flag trends belong to
Example: default
healthnumberrequired
An indicator of the project's health on a scale from 0 to 100
Example: 50
timeToProductionnumber
The average time from when a feature was created to when it was enabled in the "production" environment during the current window
Example: 10
datedate-timerequired
A UTC date when the stats were captured. Time is the very end of a given day.
Example: 2024-01-12T23:59:59.999Z
totalnumberrequired
The number of all flags on a particular day
Example: 100
activenumberrequired
The number of active flags on a particular day
Example: 98
stalenumberrequired
The number of user marked stale flags on a particular day
Example: 0
potentiallyStalenumberrequired
The number of time calculated potentially stale flags on a particular day
Example: 2
usersnumber
The number of users who have access to the project
Example: 30
]
metricsSummaryTrends object[]required
How metrics data per project changed over time
Array [
weekstringrequired
Year and week in a given year for which the metrics summary was calculated
Example: 2024-01
datedate-timerequired
A UTC date when metrics summary was captured. Time is the very end of a given day.
Example: 2024-01-12T23:59:59.999Z
projectstringrequired
Project id of the project the impressions summary belong to
Example: default
totalRequestsnumberrequired
Total number of times all project flags were requested
Example: 50
totalYesnumberrequired
Total number of times all project flags were exposed across all environments
Example: 50
totalNonumberrequired
Total number of times all project flags were not exposed across all environments
Example: 50
totalAppsnumberrequired
Total number of applications the impression data belong to
Example: 50
totalFlagsnumberrequired
Total number of flags the impression data belong to
Example: 50
totalEnvironmentsnumberrequired
Total number of environments the impression data belong to
Example: 50
]
environmentTypeTrends object[]required
How updates per environment type changed over time
Array [
datedate-timerequired
A UTC date when the stats were captured. Time is the very end of a given day.
Example: 2024-01-12T23:59:59.999Z
weekstringrequired
Year and week in a given year for which the stats were calculated
Example: 2024-01
environmentTypestringrequired
Environment type the data belongs too
Example: production
totalUpdatesnumberrequired
Total number of times configuration has been updated in the environment type
Example: 50
]

Example (auto)

{
  "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": [
    {
      "week": "2024-40",
      "project": "default",
      "health": 50,
      "timeToProduction": 10,
      "date": "2024-01-12T23:59:59.999Z",
      "total": 100,
      "active": 98,
      "stale": 0,
      "potentiallyStale": 2,
      "users": 30
    }
  ],
  "metricsSummaryTrends": [
    {
      "week": "2024-01",
      "date": "2024-01-12T23:59:59.999Z",
      "project": "default",
      "totalRequests": 50,
      "totalYes": 50,
      "totalNo": 50,
      "totalApps": 50,
      "totalFlags": 50,
      "totalEnvironments": 50
    }
  ],
  "environmentTypeTrends": [
    {
      "date": "2024-01-12T23:59:59.999Z",
      "week": "2024-01",
      "environmentType": "production",
      "totalUpdates": 50
    }
  ]
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://unleash-docs-axhngephn-unleash-team.vercel.app/api/admin/dashboard/executive' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

ResponseClear

Click the Send API Request button above and see the response here!