Get an overview of a project. | Unleash Documentation

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

{
  "version": 1,
  "name": "dx-squad",
  "onboardingStatus": {
    "status": "first-flag-created",
    "feature": "my-feature-flag"
  },
  "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.

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

{
  "version": 1,
  "name": "dx-squad",
  "onboardingStatus": {
    "status": "first-flag-created",
    "feature": "my-feature-flag"
  },
  "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 a project.

statsobject

Project statistics

descriptionstring or null

Additional information about the project

defaultStickinessstring

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

modeenum

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

Create a feature naming pattern

linkTemplateslist of objects

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

membersdouble

The number of members this project has

technicalDebtdouble0-100

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

environmentslist of objects

The environments that are enabled for this project

featureTypeCountslist of objects

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

true if the project was favorited, otherwise false.

healthdoubleDeprecated

Use technicalDebt instead.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

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

1	{
2	"version": 1,
3	"name": "dx-squad",
4	"onboardingStatus": {
5	"status": "first-flag-created",
6	"feature": "my-feature-flag"
7	},
8	"stats": {
9	"avgTimeToProdCurrentWindow": 10,
10	"createdCurrentWindow": 15,
11	"createdPastWindow": 15,
12	"archivedCurrentWindow": 5,
13	"archivedPastWindow": 5,
14	"projectActivityCurrentWindow": 100,
15	"projectActivityPastWindow": 100,
16	"projectMembersAddedCurrentWindow": 1
17	},
18	"description": "DX squad feature release",
19	"defaultStickiness": "userId",
20	"mode": "open",
21	"featureLimit": 100,
22	"featureNaming": {
23	"pattern": "^[A-Za-z]+\\.[A-Za-z]+\\.[A-Za-z0-9-]+$",
24	"example": "dx.feature.1-135",
25	"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."
26	},
27	"linkTemplates": [
28	{
29	"urlTemplate": "https://github.com/search?type=code&q=repo%3AUnleash%2F{{project}}+{{feature}}",
30	"title": "Code search"
31	}
32	],
33	"members": 4,
34	"technicalDebt": 25,
35	"environments": [
36	{
37	"environment": "development"
38	},
39	{
40	"environment": "production",
41	"defaultStrategy": {
42	"name": "flexibleRollout",
43	"constraints": [],
44	"parameters": {
45	"rollout": "50",
46	"stickiness": "customAppName",
47	"groupId": "stickyFlag"
48	}
49	}
50	}
51	],
52	"featureTypeCounts": [
53	{
54	"type": "kill-switch",
55	"count": 1
56	}
57	],
58	"updatedAt": "2023-02-10T08:36:35.262Z",
59	"archivedAt": "2023-02-10T08:36:35.262Z",
60	"createdAt": "2023-02-10T08:36:35.262Z",
61	"favorite": true,
62	"health": 50
63	}