Get instance information | Unleash Documentation

curl https://app.unleash-instance.example.com/api/admin/insights \
     -H "Authorization: <apiKey>"

{
  "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",
      "date": "2024-01-12T23:59:59.999Z",
      "total": 100,
      "active": 98,
      "stale": 0,
      "potentiallyStale": 2,
      "health": 50,
      "technicalDebt": 20,
      "timeToProduction": 10,
      "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
    }
  ],
  "lifecycleTrends": [
    {
      "week": "2024-15",
      "date": "2024-04-12T23:59:59.999Z",
      "newProductionFlags": 5,
      "project": "default"
    }
  ],
  "creationArchiveTrends": [
    {
      "week": "2024-15",
      "date": "2024-04-12T23:59:59.999Z",
      "project": "default",
      "createdFlags": {
        "experiment": 5,
        "release": 2,
        "operational": 1
      },
      "archivedFlags": 3
    }
  ]
}

Enterprise feature

Gets high level information about the usage of this Unleash instance, including user, project, and flag information.

curl https://app.unleash-instance.example.com/api/admin/insights \
     -H "Authorization: <apiKey>"

{
  "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",
      "date": "2024-01-12T23:59:59.999Z",
      "total": 100,
      "active": 98,
      "stale": 0,
      "potentiallyStale": 2,
      "health": 50,
      "technicalDebt": 20,
      "timeToProduction": 10,
      "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
    }
  ],
  "lifecycleTrends": [
    {
      "week": "2024-15",
      "date": "2024-04-12T23:59:59.999Z",
      "newProductionFlags": 5,
      "project": "default"
    }
  ],
  "creationArchiveTrends": [
    {
      "week": "2024-15",
      "date": "2024-04-12T23:59:59.999Z",
      "project": "default",
      "createdFlags": {
        "experiment": 5,
        "release": 2,
        "operational": 1
      },
      "archivedFlags": 3
    }
  ]
}

Enterprise feature

Gets high level information about the usage of this Unleash instance, including user, project, and flag information.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Query parameters

fromstringOptional

The beginning of the date range in yyyy-MM-dd format

tostringOptional

The end of the date range in yyyy-MM-dd format

Response

instanceInsightsSchema

userTrendslist of objects

How number of users changed over time

flagTrendslist of objects

How number of flags changed over time

projectFlagTrendslist of objects

How number of flags per project changed over time

metricsSummaryTrendslist of objects

How metrics data per project changed over time

environmentTypeTrendslist of objects

How updates per environment type changed over time

lifecycleTrendslist of objects

Weekly count of new flags entering production

creationArchiveTrendslist of objects

Weekly count of created vs archived flags by project and flag type

$	curl https://app.unleash-instance.example.com/api/admin/insights \
>	-H "Authorization: <apiKey>"

1	{
2	"userTrends": [
3	{
4	"date": "2024-01-12T23:59:59.999Z",
5	"total": 100,
6	"active": 98,
7	"inactive": 2
8	}
9	],
10	"flagTrends": [
11	{
12	"date": "2024-01-12T23:59:59.999Z",
13	"total": 100,
14	"active": 98,
15	"stale": 0,
16	"potentiallyStale": 2
17	}
18	],
19	"projectFlagTrends": [
20	{
21	"week": "2024-40",
22	"project": "default",
23	"date": "2024-01-12T23:59:59.999Z",
24	"total": 100,
25	"active": 98,
26	"stale": 0,
27	"potentiallyStale": 2,
28	"health": 50,
29	"technicalDebt": 20,
30	"timeToProduction": 10,
31	"users": 30
32	}
33	],
34	"metricsSummaryTrends": [
35	{
36	"week": "2024-01",
37	"date": "2024-01-12T23:59:59.999Z",
38	"project": "default",
39	"totalRequests": 50,
40	"totalYes": 50,
41	"totalNo": 50,
42	"totalApps": 50,
43	"totalFlags": 50,
44	"totalEnvironments": 50
45	}
46	],
47	"environmentTypeTrends": [
48	{
49	"date": "2024-01-12T23:59:59.999Z",
50	"week": "2024-01",
51	"environmentType": "production",
52	"totalUpdates": 50
53	}
54	],
55	"lifecycleTrends": [
56	{
57	"week": "2024-15",
58	"date": "2024-04-12T23:59:59.999Z",
59	"newProductionFlags": 5,
60	"project": "default"
61	}
62	],
63	"creationArchiveTrends": [
64	{
65	"week": "2024-15",
66	"date": "2024-04-12T23:59:59.999Z",
67	"project": "default",
68	"createdFlags": {
69	"experiment": 5,
70	"release": 2,
71	"operational": 1
72	},
73	"archivedFlags": 3
74	}
75	]
76	}