Get project status

GET 
https://us.app.unleash-hosted.com/ushosted/api/admin/projects/:projectId/status

This endpoint returns information on the status the project, including activities, health, resources, and aggregated flag lifecycle data.

Request

Path Parameters

projectId stringrequired

Responses

200

projectStatusSchema

application/json

Schema

Schema

activityCountByDate

object[]

required

Array of activity records with date and count, representing the project’s daily activity statistics.

Array [

date stringrequired

Activity date

Example: 2022-12-14

count integerrequired

Activity count

]

averageHealth integerrequired

The average health score over the last 4 weeks, indicating whether features are stale or active.

resources

object

required

Key resources within the project

connectedEnvironments numberrequired

The number of environments that have received SDK traffic in this project.

apiTokens numberrequired

The number of API tokens created specifically for this project.

members numberrequired

The number of users who have been granted roles in this project. Does not include users who have access via groups.

segments numberrequired

The number of segments that are scoped to this project.

Example (from schema)

{
  "activityCountByDate": [
    {
      "date": "2022-12-14",
      "count": 0
    }
  ],
  "averageHealth": 0,
  "resources": {
    "connectedEnvironments": 0,
    "apiTokens": 0,
    "members": 0,
    "segments": 0
  }
}

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

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
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 (from schema)

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

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

Example (from schema)

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

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

Example (from schema)

{
  "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 'https://us.app.unleash-hosted.com/ushosted/api/admin/projects/:projectId/status' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://us.app.unleash-hosted.com/ushosted

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

projectId — pathrequired

ResponseClear

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