Get an overview of a project insights.

GET 
/api/admin/projects/:projectId/insights

This endpoint returns insights into the specified projects stats, health, lead time for changes, feature types used, members and change requests.

Request

Path Parameters

projectId stringrequired

Responses

200

projectInsightsSchema

application/json

Schema

Schema

stats

object

required

Project statistics

avgTimeToProdCurrentWindow numberrequired

The average time from when a feature was created to when it was enabled in the "production" environment during the current window

Example: 10

createdCurrentWindow numberrequired

The number of feature flags created during the current window

Example: 15

createdPastWindow numberrequired

The number of feature flags created during the previous window

Example: 15

archivedCurrentWindow numberrequired

The number of feature flags that were archived during the current window

Example: 5

archivedPastWindow numberrequired

The number of feature flags that were archived during the previous window

Example: 5

projectActivityCurrentWindow numberrequired

The number of project events that occurred during the current window

Example: 100

projectActivityPastWindow numberrequired

The number of project events that occurred during the previous window

Example: 100

projectMembersAddedCurrentWindow numberrequired

The number of members that were added to the project during the current window

Example: 1

health

object

required

Health summary of the project

rating integerrequired

An indicator of the project's health on a scale from 0 to 100

Example: 95

activeCount numberrequired

The number of active feature flags.

Example: 12

potentiallyStaleCount numberrequired

The number of potentially stale feature flags.

Example: 5

staleCount numberrequired

The number of stale feature flags.

Example: 10

leadTime

object

required

Lead time (DORA) metrics

projectAverage number

The average time it takes a feature flag to be enabled in production. The measurement unit is days.

features

object[]

required

An array of objects containing feature flag name and timeToProduction values. The measurement unit of timeToProduction is days.

Array [

name stringrequired

The name of a feature flag

timeToProduction numberrequired

The average number of days it takes a feature flag to get into production

]

featureTypeCounts

object[]

required

The number of features of each type

Array [

type stringrequired

Type of the flag e.g. experiment, kill-switch, release, operational, permission

Example: kill-switch

count numberrequired

Number of feature flags of this type

Example: 1

]

members

object

required

Active/inactive users summary

currentMembers numberrequired

The number of total project members

Example: 10

change numberrequired

The change in the number of project members compared to the previous month

Example: 10

Example (from schema)

{
  "stats": {
    "avgTimeToProdCurrentWindow": 10,
    "createdCurrentWindow": 15,
    "createdPastWindow": 15,
    "archivedCurrentWindow": 5,
    "archivedPastWindow": 5,
    "projectActivityCurrentWindow": 100,
    "projectActivityPastWindow": 100,
    "projectMembersAddedCurrentWindow": 1
  },
  "health": {
    "rating": 95,
    "activeCount": 12,
    "potentiallyStaleCount": 5,
    "staleCount": 10
  },
  "leadTime": {
    "projectAverage": 0,
    "features": [
      {
        "name": "string",
        "timeToProduction": 0
      }
    ]
  },
  "featureTypeCounts": [
    {
      "type": "kill-switch",
      "count": 1
    }
  ],
  "members": {
    "currentMembers": 10,
    "change": 10
  }
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: NoAccessError
message string
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

404

The requested resource was not found.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: NotFoundError
message string
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Loading...