Skip to main content

Get an overview of a project.

GET 
/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​

projectOverviewSchema

Schema

    stats

    object

    Project statistics

    avgTimeToProdCurrentWindow numberrequired

    The average time from when a feature was created to when it was enabled in the "production" environment during the current window

    Example: 10
    createdCurrentWindow numberrequired

    The number of feature flags created during the current window

    Example: 15
    createdPastWindow numberrequired

    The number of feature flags created during the previous window

    Example: 15
    archivedCurrentWindow numberrequired

    The number of feature flags that were archived during the current window

    Example: 5
    archivedPastWindow numberrequired

    The number of feature flags that were archived during the previous window

    Example: 5
    projectActivityCurrentWindow numberrequired

    The number of project events that occurred during the current window

    Example: 100
    projectActivityPastWindow numberrequired

    The number of project events that occurred during the previous window

    Example: 100
    projectMembersAddedCurrentWindow numberrequired

    The number of members that were added to the project during the current window

    Example: 1
    version integerrequired

    The schema version used to describe the project overview

    Example: 1
    name stringrequired

    The name of this project

    Example: dx-squad
    description stringnullable

    Additional information about the project

    Example: DX squad feature release
    defaultStickiness string

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

    Example: userId
    mode string

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

    Possible values: [open, protected, private]

    Example: open
    featureLimit numbernullable

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

    Example: 100

    featureNaming

    object

    Create a feature naming pattern

    pattern stringnullablerequired

    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-]+$
    example stringnullable

    An example of a feature name that matches the pattern. Must itself match the pattern supplied.

    Example: dx.feature1.1-135
    description stringnullable

    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.
    members number

    The number of members this project has

    Example: 4
    health number

    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 [

    • environment stringrequired

    The environment to add to the project

    Example: development
    changeRequestsEnabled boolean

    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.

    name stringrequired

    The name of the strategy type

    Example: flexibleRollout
    title stringnullable

    A descriptive title for the strategy

    Example: Gradual Rollout 25-Prod
    disabled booleannullable

    A toggle to disable the strategy. defaults to false. Disabled strategies are not evaluated or returned to the SDKs

    Example: false
    sortOrder number

    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/strategy-constraints

  • Array [

    • contextName stringrequired

    The name of the context field that this constraint should apply to.

    Example: appName
    operator stringrequired

    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
    caseInsensitive boolean

    Whether the operator should be case sensitive or not. Defaults to false (being case sensitive).

    Default value: false
    inverted boolean

    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
    values string[]

    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"]
    value string

    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 [

    • name stringrequired

    The variant name. Must be unique for this feature flag

    Example: blue_group
    weight integerrequired

    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

    weightType stringrequired

    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
    stickiness stringrequired

    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

    type stringrequired

    The type of the value. Commonly used types are string, number, json and csv.

    Possible values: [json, csv, string, number]

    value stringrequired

    The actual value of payload

  • ]

    • parameters

    object

    A list of parameters for a strategy

    property name* string
    segments number[]

    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 [

    • type stringrequired

    Type of the flag e.g. experiment, kill-switch, release, operational, permission

    Example: kill-switch
    count numberrequired

    Number of feature flags of this type

    Example: 1

  • ]

    • updatedAt date-timenullable

    When the project was last updated.

    Example: 2023-02-10T08:36:35.262Z
    archivedAt date-timenullable

    When the project was archived.

    Example: 2023-02-10T08:36:35.262Z
    createdAt date-timenullable

    When the project was created.

    Example: 2023-02-10T08:36:35.262Z
    favorite boolean

    true if the project was favorited, otherwise false.

    Example: true

    onboardingStatus

    object

    required

    The current onboarding status of the project.

    oneOf

    status stringrequired

    Possible values: [onboarding-started, onboarded]

    Example: onboarding-started
Loading...