UNunleash
Projects

Get a health report for a project.

Changed on

This endpoint returns a health report for the specified project. This data is used for the technical debt insights

get/api/admin/projects/{projectId}/health-report

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/projects/{projectId}/health-report
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

projectIdstring required

Response

healthReportSchema

versioninteger required

The project overview version.

namestring required

The project's name

descriptionstring nullable

The project's description

defaultStickinessstring required

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

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

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.

membersinteger required

The number of users/members in the project.

healthinteger required

Use technicalDebt instead.

technicalDebtnumber required

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.

createdAtstring date-time nullable

When the project was last updated.

favoriteboolean

Indicates if the project has been marked as a favorite by the current user requesting the project health overview.

potentiallyStaleCountnumber required

The number of potentially stale feature flags.

activeCountnumber required

The number of active feature flags.

staleCountnumber required

The number of stale feature flags.

Changes

  • b2c3116e633eRevision changes
    • warning

      added the new SEMVER_GTE enum value to the ///// response property for the response status

    • warning

      added the new SEMVER_GTE enum value to the //////////// response property for the response status

    • warning

      added the new SEMVER_GTE enum value to the //////// response property for the response status

    • warning

      added the new SEMVER_LTE enum value to the ///// response property for the response status

    • warning

      added the new SEMVER_LTE enum value to the //////////// response property for the response status

    • warning

      added the new SEMVER_LTE enum value to the //////// response property for the response status

  • 774670258f04Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      added the new REGEX enum value to the ///// response property for the response status

    • warning

      added the new REGEX enum value to the //////////// response property for the response status

    • warning

      added the new REGEX enum value to the //////// response property for the response status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      response property features/items/environments/items/releasePlans/items/milestones/items/strategies/items/strategyName deprecated (stability: stable)

    • info

      added the required property ////////// to the response with the status