Get personal project details

GET 
https://us.app.unleash-hosted.com/ushosted/api/admin/personal-dashboard/:projectId

Return personal dashboard project events, owners, user roles and onboarding status

Request

Path Parameters

projectId stringrequired

Responses

200

personalDashboardProjectDetailsSchema

application/json

Schema

Schema

insights

object

required

Insights for the project, including flag data and project health information.

avgHealthCurrentWindow integernullablerequired

The project's average health score over the last 4 weeks

Example: 80

avgHealthPastWindow integernullablerequired

The project's average health score over the previous 4-week window

Example: 70

totalFlags integerrequired

The current number of non-archived flags

Example: 100

activeFlags integerrequired

The number of active flags that are not stale or potentially stale

Example: 98

staleFlags integerrequired

The current number of flags that have been manually marked as stale

Example: 0

potentiallyStaleFlags integerrequired

The number of potentially stale flags as calculated by Unleash

Example: 2

health integerrequired

The project's current health score

Example: 80

onboardingStatus

object

required

The current onboarding status of the project.

oneOf

MOD1

status stringrequired

Possible values: [onboarding-started, onboarded]

Example: onboarding-started

MOD2

status stringrequired

Possible values: [first-flag-created]

Example: first-flag-created

feature stringrequired

The name of the feature flag

Example: my-feature-flag

latestEvents

object[]

required

The latest events for the project.

Array [

id integerrequired

The ID of the event.

Possible values: >= 1

summary stringnullablerequired

[Experimental] A markdown-formatted summary of the event.

createdBy stringrequired

Which user created this event

Example: johndoe

createdByImageUrl stringrequired

URL used for the user profile image of the event author

Example: https://example.com/242x200.png

createdAt date-timerequired

When the event was recorded

Example: 2021-09-01T12:00:00Z

]

owners

object

required

The users and/or groups that have the "owner" role in this project. If no such users or groups exist, the list will contain the "system" owner instead.

oneOf

MOD1

Array [

anyOf

MOD1

ownerType stringrequired

Possible values: [user]

name stringrequired

Example: User Name

imageUrl stringnullable

Example: https://example.com/image.jpg

email stringnullable

Example: user@example.com

MOD2

ownerType stringrequired

Possible values: [group]

name stringrequired

Example: Group Name

]

MOD2

Array [

ownerType stringrequired

Possible values: [system]

]

roles

object[]

required

The list of roles that the user has in this project.

Array [

name stringrequired

The name of the role

Example: Owner

id integerrequired

The id of the role

Example: 4

type stringrequired

The type of the role

Possible values: [custom, project]

Example: project

]

Example (from schema)

{
  "insights": {
    "avgHealthCurrentWindow": 80,
    "avgHealthPastWindow": 70,
    "totalFlags": 100,
    "activeFlags": 98,
    "staleFlags": 0,
    "potentiallyStaleFlags": 2,
    "health": 80
  },
  "onboardingStatus": {},
  "latestEvents": [
    {
      "id": 0,
      "summary": "string",
      "createdBy": "johndoe",
      "createdByImageUrl": "https://example.com/242x200.png",
      "createdAt": "2021-09-01T12:00:00Z"
    }
  ],
  "owners": [
    null
  ],
  "roles": [
    {
      "name": "Owner",
      "id": 4,
      "type": "project"
    }
  ]
}

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/personal-dashboard/:projectId' \
-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!