Get an overview of a project. | Unleash Documentation

import requests
url = "https://app.unleash-instance.example.com/api/admin/projects/projectId/overview"
headers = {"Authorization": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "version": 1,
  "name": "dx-squad",
  "onboardingStatus": {
    "status": "onboarding-started"
  },
  "stats": {
    "avgTimeToProdCurrentWindow": 10,
    "createdCurrentWindow": 15,
    "createdPastWindow": 15,
    "archivedCurrentWindow": 5,
    "archivedPastWindow": 5,
    "projectActivityCurrentWindow": 100,
    "projectActivityPastWindow": 100,
    "projectMembersAddedCurrentWindow": 1
  },
  "description": "DX squad feature release",
  "defaultStickiness": "userId",
  "mode": "open",
  "featureLimit": 100,
  "featureNaming": {
    "pattern": "^[A-Za-z]+\\.[A-Za-z]+\\.[A-Za-z0-9-]+$",
    "example": "dx.feature.1-135",
    "description": "<project>.<featureName>.<ticket>\n\nThe flag name should contain the project name, the feature name, and the ticket number, each separated by a dot."
  },
  "linkTemplates": [
    {
      "urlTemplate": "https://github.com/search?type=code&q=repo%3AUnleash%2F{{project}}+{{feature}}",
      "title": "Code search"
    }
  ],
  "members": 4,
  "technicalDebt": 25,
  "environments": [
    {
      "environment": "development"
    },
    {
      "environment": "production",
      "defaultStrategy": {
        "name": "flexibleRollout",
        "constraints": [],
        "parameters": {
          "rollout": "50",
          "stickiness": "customAppName",
          "groupId": "stickyFlag"
        }
      }
    }
  ],
  "featureTypeCounts": [
    {
      "type": "kill-switch",
      "count": 1
    }
  ],
  "updatedAt": "2023-02-10T08:36:35.262Z",
  "archivedAt": "2023-02-10T08:36:35.262Z",
  "createdAt": "2023-02-10T08:36:35.262Z",
  "favorite": true,
  "health": 50
}

This endpoint returns an overview of the specified projects stats, project health, number of members, which environments are configured, and the features types in the project.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

Path parameters

projectIdstringRequired

Response

projectOverviewSchema

versioninteger

The schema version used to describe the project overview

namestring

The name of this project

onboardingStatusobject

The current onboarding status of the project.

statsobject or null

Project statistics

descriptionstring or null

Additional information about the project

defaultStickinessstring or null

A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy

modeenum or null

The project’s collaboration mode. Determines whether non-project members can submit change requests or not.

Allowed values:

featureLimitdouble or null

A limit on the number of features allowed in the project. Null if no limit.

featureNamingobject or null

Create a feature naming pattern

linkTemplateslist of objects or null

A list of templates for links that will be automatically added to new feature flags.

membersdouble or null

The number of members this project has

technicalDebtdouble or null0-100

An indicator of the project’s technical debt on a scale from 0 to 100

environmentslist of objects or null

The environments that are enabled for this project

featureTypeCountslist of objects or null

The number of features of each type that are in this project

updatedAtstring or nullformat: "date-time"

When the project was last updated.

archivedAtstring or nullformat: "date-time"

When the project was archived.

createdAtstring or nullformat: "date-time"

When the project was created.

favoriteboolean or null

true if the project was favorited, otherwise false.

healthdouble or nullDeprecated

Use technicalDebt instead.

Authentication

Path parameters

Response

Errors