Get personal project details

GET /api/admin/personal-dashboard/:projectId

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

Request

Path Parameters

• projectId string required

Responses

• 200
• 401
• 403
• 404

---

personalDashboardProjectDetailsSchema

application/json

Schema

Schema

• insights objectrequired

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

  avgHealthCurrentWindow integer nullable required

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

  avgHealthPastWindow integer nullable required

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

  totalFlags integer required

  The current number of non-archived flags

  activeFlags integer required

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

  staleFlags integer required

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

  potentiallyStaleFlags integer required

  The number of potentially stale flags as calculated by Unleash

  health integer required

  The project's current health score

• onboardingStatus objectrequired

  The current onboarding status of the project.

  oneOf

  MOD1

  status string required

  Possible values: [onboarding-started, onboarded]

  MOD2

  status string required

  Possible values: [first-flag-created]

  feature string required

  The name of the feature flag

• latestEvents object[]required

  The latest events for the project.

  Array [

  id integer required

  Possible values: >= 1

  The ID of the event.

  summary string nullable required

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

  createdBy string required

  Which user created this event

  createdByImageUrl string required

  URL used for the user profile image of the event author

  createdAt date-time required

  When the event was recorded

  ]
• owners objectrequired

  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 string required

  Possible values: [user]

  name string required

  imageUrl string nullable

  email string nullable

  MOD2

  ownerType string required

  Possible values: [group]

  name string required

  ]

  MOD2

  Array [

  ownerType string required

  Possible values: [system]

  ]
• roles object[]required

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

  Array [

  name string required

  The name of the role

  id integer required

  The id of the role

  type string required

  Possible values: [custom, project]

  The type of the role

  ]

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"
    }
  ]
}

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

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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."
}

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

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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."
}

The requested resource was not found.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Loading...