Get an overview of a project.

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

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.

Request

Path Parameters

projectId stringrequired

Responses

200

projectOverviewSchema

application/json

Schema

Schema

stats object
Project statistics
avgTimeToProdCurrentWindownumberrequired
The average time from when a feature was created to when it was enabled in the "production" environment during the current window
Example: 10
createdCurrentWindownumberrequired
The number of feature flags created during the current window
Example: 15
createdPastWindownumberrequired
The number of feature flags created during the previous window
Example: 15
archivedCurrentWindownumberrequired
The number of feature flags that were archived during the current window
Example: 5
archivedPastWindownumberrequired
The number of feature flags that were archived during the previous window
Example: 5
projectActivityCurrentWindownumberrequired
The number of project events that occurred during the current window
Example: 100
projectActivityPastWindownumberrequired
The number of project events that occurred during the previous window
Example: 100
projectMembersAddedCurrentWindownumberrequired
The number of members that were added to the project during the current window
Example: 1
versionintegerrequired
The schema version used to describe the project overview
Example: 1
namestringrequired
The name of this project
Example: dx-squad
descriptionstringnullable
Additional information about the project
Example: DX squad feature release
defaultStickinessstring
A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy
Example: userId
modestring
The project's collaboration mode. Determines whether non-project members can submit change requests or not.
Possible values: [open, protected, private]
Example: open
featureLimitnumbernullable
A limit on the number of features allowed in the project. Null if no limit.
Example: 100
featureNaming object
Create a feature naming pattern
patternstringnullablerequired
A JavaScript regular expression pattern, without the start and end delimiters. Optional flags are not allowed.
Example: ^[A-Za-z]+\.[A-Za-z]+\.[A-Za-z0-9-]+$
examplestringnullable
An example of a feature name that matches the pattern. Must itself match the pattern supplied.
Example: dx.feature1.1-135
descriptionstringnullable
A description of the pattern in a human-readable format. Will be shown to users when they create a new feature flag.
Example: <project>.<featureName>.<ticket> The flag name should contain the project name, the feature name, and the ticket number, each separated by a dot.
membersnumber
The number of members this project has
Example: 4
healthnumber
An indicator of the project's health on a scale from 0 to 100
Example: 50
environments object[]
The environments that are enabled for this project
Array [
environmentstringrequired
The environment to add to the project
Example: development
changeRequestsEnabledboolean
Whether change requests should be enabled or for this environment on the project or not
Example: true
defaultStrategy object
A default strategy to create for this environment on the project.
namestringrequired
The name of the strategy type
Example: flexibleRollout
titlestringnullable
A descriptive title for the strategy
Example: Gradual Rollout 25-Prod
disabledbooleannullable
A toggle to disable the strategy. defaults to false. Disabled strategies are not evaluated or returned to the SDKs
Example: false
sortOrdernumber
The order of the strategy in the list
Example: 9999
constraints object[]
A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/activation-strategies#constraints
Array [
contextNamestringrequired
The name of the context field that this constraint should apply to.
Example: appName
operatorstringrequired
The operator to use when evaluating this constraint. For more information about the various operators, refer to the strategy constraint operator documentation.
Possible values: [NOT_IN, IN, STR_ENDS_WITH, STR_STARTS_WITH, STR_CONTAINS, NUM_EQ, NUM_GT, NUM_GTE, NUM_LT, NUM_LTE, DATE_AFTER, DATE_BEFORE, SEMVER_EQ, SEMVER_GT, SEMVER_LT]
Example: IN
caseInsensitiveboolean
Whether the operator should be case sensitive or not. Defaults to false (being case sensitive).
Default value: false
invertedboolean
Whether the result should be negated or not. If true, will turn a true result into a false result and vice versa.
Default value: false
valuesstring[]
The context values that should be used for constraint evaluation. Use this property instead of value for properties that accept multiple values.
Example: ["my-app","my-other-app"]
valuestring
The context value that should be used for constraint evaluation. Use this property instead of values for properties that only accept single values.
Example: my-app
]
variants object[]
Strategy level variants
Array [
namestringrequired
The variant name. Must be unique for this feature flag
Example: blue_group
weightintegerrequired
The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on variant weights for more information
Possible values: <= 1000
weightTypestringrequired
Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the variant weight documentation.
Possible values: [variable, fix]
Example: fix
stickinessstringrequired
The stickiness to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time
Example: custom.context.field
payload object
Extra data configured for this variant
typestringrequired
The type of the value. Commonly used types are string, number, json and csv.
Possible values: [json, csv, string, number]
valuestringrequired
The actual value of payload
]
parameters object
A list of parameters for a strategy
property name*string
segmentsnumber[]
Ids of segments to use for this strategy
Example: [1,2]
]
featureTypeCounts object[]
The number of features of each type that are in this project
Array [
typestringrequired
Type of the flag e.g. experiment, kill-switch, release, operational, permission
Example: kill-switch
countnumberrequired
Number of feature flags of this type
Example: 1
]
updatedAtdate-timenullable
When the project was last updated.
Example: 2023-02-10T08:36:35.262Z
archivedAtdate-timenullable
When the project was archived.
Example: 2023-02-10T08:36:35.262Z
createdAtdate-timenullable
When the project was created.
Example: 2023-02-10T08:36:35.262Z
favoriteboolean
true if the project was favorited, otherwise false.
Example: true
onboardingStatus objectrequired
The current onboarding status of the project.
oneOf
MOD1
statusstringrequired
Possible values: [onboarding-started, onboarded]
Example: onboarding-started
MOD2
statusstringrequired
Possible values: [first-flag-created]
Example: first-flag-created
featurestringrequired
The name of the feature flag
Example: my-feature-flag

Example (auto)

{
  "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.feature1.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."
  },
  "members": 4,
  "health": 50,
  "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"
  }
}

401

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

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: AuthenticationRequired
messagestring
A description of what went wrong.
Example: 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.

Example (auto)

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

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NoAccessError
messagestring
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

404

The requested resource was not found.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NotFoundError
messagestring
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (auto)

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

Authorization: Authorization

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

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

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

projectId — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!