Projects
Get an overview of a project.
Changed onThis 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
Request
- Base URLhttps://app.unleash-instance.example.com
- URLhttps://app.unleash-instance.example.com/api/admin/projects/{projectId}/overview
- Auth
- API key in header Authorization
- or HTTP bearer
Path parameters
projectIdstring required
Response
projectOverviewSchema
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"
}
}Changes
- warning
added the new
SEMVER_GTEenum value to the/////response property for the response status - warning
added the new
SEMVER_LTEenum value to the/////response property for the response status
- warning
- warning
added the new
REGEXenum value to the/////response property for the response status - warning
added the new
sdk-connectedenum value to the//response property for the response status
- warning