Get an overview of a project insights.

GET <your-unleash-url>/api/admin/projects/:projectId/insights

Authorization

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

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 string required

Responses

• 200
• 401
• 403
• 404

---

projectInsightsSchema

application/json

Schema

Schema

• stats objectrequired

  Project statistics

  avgTimeToProdCurrentWindow number required

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

  createdCurrentWindow number required

  The number of feature toggles created during the current window

  createdPastWindow number required

  The number of feature toggles created during the previous window

  archivedCurrentWindow number required

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

  archivedPastWindow number required

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

  projectActivityCurrentWindow number required

  The number of project events that occurred during the current window

  projectActivityPastWindow number required

  The number of project events that occurred during the previous window

  projectMembersAddedCurrentWindow number required

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

• health objectrequired

  Health summary of the project

  rating integer required

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

  activeCount number required

  The number of active feature toggles.

  potentiallyStaleCount number required

  The number of potentially stale feature toggles.

  staleCount number required

  The number of stale feature toggles.

• leadTime objectrequired

  Lead time (DORA) metrics

  projectAverage number

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

  features object[]required

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

  Array [

  name string required

  The name of a feature toggle

  timeToProduction number required

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

  ]
• featureTypeCounts object[]required

  The number of features of each type

  Array [

  type string required

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

  count number required

  Number of feature flags of this type

  ]
• members objectrequired

  Active/inactive users summary

  currentMembers number required

  The number of total project members

  change number required

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

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
  }
}

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

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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."
}

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

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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."
}

The requested resource was not found.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

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

Authorization

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

Request

Base URL

<your-unleash-url>

Security Scheme

apiKeybearerToken

apiKey

projectId — path required

curl / cURL

curl -L -X GET '<your-unleash-url>/api/admin/projects/:projectId/insights' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

python / requests

curl -L -X GET '<your-unleash-url>/api/admin/projects/:projectId/insights' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

go / native

curl -L -X GET '<your-unleash-url>/api/admin/projects/:projectId/insights' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

nodejs / axios

curl -L -X GET '<your-unleash-url>/api/admin/projects/:projectId/insights' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

ruby / Net::HTTP

curl -L -X GET '<your-unleash-url>/api/admin/projects/:projectId/insights' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

csharp / RestSharp

curl -L -X GET '<your-unleash-url>/api/admin/projects/:projectId/insights' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

php / cURL

curl -L -X GET '<your-unleash-url>/api/admin/projects/:projectId/insights' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

java / OkHttp

curl -L -X GET '<your-unleash-url>/api/admin/projects/:projectId/insights' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

powershell / RestMethod

curl -L -X GET '<your-unleash-url>/api/admin/projects/:projectId/insights' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'