Get personal project details
GET/api/admin/personal-dashboard/:projectId
Return personal dashboard project events, owners, user roles and onboarding status
Request
Path Parameters
Responses
- 200
- 401
- 403
- 404
personalDashboardProjectDetailsSchema
- application/json
- Schema
- Example (from schema)
Schema
- MOD1
- MOD2
Array [
]
- MOD1
- MOD2
Array [
- MOD1
- MOD2
]
Array [
]
Array [
]
insights
object
required
Insights for the project, including flag data and project health information.
The project's average health score over the last 4 weeks
80
The project's average health score over the previous 4-week window
70
The current number of non-archived flags
100
The number of active flags that are not stale or potentially stale
98
The current number of flags that have been manually marked as stale
0
The number of potentially stale flags as calculated by Unleash
2
The project's current health score
80
onboardingStatus
object
required
The current onboarding status of the project.
oneOf
Possible values: [onboarding-started
, onboarded
]
onboarding-started
Possible values: [first-flag-created
]
first-flag-created
The name of the feature flag
my-feature-flag
latestEvents
object[]
required
The latest events for the project.
The ID of the event.
Possible values: >= 1
[Experimental] A markdown-formatted summary of the event.
Which user created this event
johndoe
URL used for the user profile image of the event author
https://example.com/242x200.png
When the event was recorded
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
anyOf
Possible values: [user
]
User Name
https://example.com/image.jpg
user@example.com
Possible values: [group
]
Group Name
Possible values: [system
]
roles
object[]
required
The list of roles that the user has in this project.
The name of the role
Owner
The id of the role
4
The type of the role
Possible values: [custom
, project
]
project
{
"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"
}
]
}
Authorization information is missing or invalid. Provide a valid API token as the authorization
header, e.g. authorization:*.*.my-admin-token
.
- application/json
- Schema
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
AuthenticationRequired
A description of what went wrong.
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.
{
"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."
}
The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
NoAccessError
A description of what went wrong.
You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NoAccessError",
"message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}
The requested resource was not found.
- application/json
- Schema
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
NotFoundError
A description of what went wrong.
Could not find the addon with ID "12345".
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NotFoundError",
"message": "Could not find the addon with ID \"12345\"."
}