v7

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-013764062.2 MB

Projects

Get an overview of a project.

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.

get/api/admin/projects/{projectId}/overview

Path parameters

projectIdstring required

Response

projectOverviewSchema

versioninteger required

The schema version used to describe the project overview

namestring required

The name of this project

descriptionstring nullable

Additional information about the project

defaultStickinessstring

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

mode'open' | 'protected' | 'private'

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

featureLimitnumber nullable

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

membersnumber

The number of members this project has

healthnumber

Use technicalDebt instead.

technicalDebtnumber

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

updatedAtstring date-time nullable

When the project was last updated.

archivedAtstring date-time nullable

When the project was archived.

createdAtstring date-time nullable

When the project was created.

favoriteboolean

true if the project was favorited, otherwise false.

Example response

{
  "stats": {
    "avgTimeToProdCurrentWindow": 10,
    "createdCurrentWindow": 15,
    "createdPastWindow": 15,
    "archivedCurrentWindow": 5,
    "archivedPastWindow": 5,
    "projectActivityCurrentWindow": 100,
    "projectActivityPastWindow": 100,
    "projectMembersAddedCurrentWindow": 1
  },
  "version": 1,
  "name": "dx-squad",
  "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": [
    {
      "title": "Code search",
      "urlTemplate": "https://github.com/search?type=code&q=repo%3AUnleash%2F{{project}}+{{feature}}"
    }
  ],
  "members": 4,
  "health": 50,
  "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,
  "onboardingStatus": {
    "status": "onboarding-started"
  }
}