Skip to main content

Get instance information

GET 

/api/admin/dashboard/executive

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Gets high level information about the usage of this Unleash instance, including user, project, and flag information. This endpoint is deprecated and will be removed in a future minor version. Please use /api/admin/insights instead.

Responses

instanceInsightsSchema

Schema

    userTrends

    object[]

    required

    How number of users changed over time

  • Array [

  • date date-timerequired

    A UTC date when the stats were captured. Time is the very end of a given day.

    Example: 2024-01-12T23:59:59.999Z
    total numberrequired

    The number of actual Unleash users on a particular day

    Example: 100
    active numberrequired

    The number of active Unleash users on a particular day

    Example: 98
    inactive numberrequired

    The number of inactive Unleash users on a particular day

    Example: 2
  • ]

  • flagTrends

    object[]

    required

    How number of flags changed over time

  • Array [

  • date date-timerequired

    A UTC date when the stats were captured. Time is the very end of a given day.

    Example: 2024-01-12T23:59:59.999Z
    total numberrequired

    The number of all flags on a particular day

    Example: 100
    active numberrequired

    The number of active flags on a particular day

    Example: 98
    stale numberrequired

    The number of user marked stale flags on a particular day

    Example: 0
    potentiallyStale numberrequired

    The number of time calculated potentially stale flags on a particular day

    Example: 2
  • ]

  • projectFlagTrends

    object[]

    required

    How number of flags per project changed over time

  • Array [

  • week stringrequired

    Year and week in a given year for which the stats were calculated

    Example: 2024-40
    project stringrequired

    Project id of the project the flag trends belong to

    Example: default
    health numberrequired

    An indicator of the project's health on a scale from 0 to 100

    Example: 50
    timeToProduction number

    The average time from when a feature was created to when it was enabled in the "production" environment during the current window

    Example: 10
    date date-timerequired

    A UTC date when the stats were captured. Time is the very end of a given day.

    Example: 2024-01-12T23:59:59.999Z
    total numberrequired

    The number of all flags on a particular day

    Example: 100
    active numberrequired

    The number of active flags on a particular day

    Example: 98
    stale numberrequired

    The number of user marked stale flags on a particular day

    Example: 0
    potentiallyStale numberrequired

    The number of time calculated potentially stale flags on a particular day

    Example: 2
    users number

    The number of users who have access to the project

    Example: 30
  • ]

  • metricsSummaryTrends

    object[]

    required

    How metrics data per project changed over time

  • Array [

  • week stringrequired

    Year and week in a given year for which the metrics summary was calculated

    Example: 2024-01
    date date-timerequired

    A UTC date when metrics summary was captured. Time is the very end of a given day.

    Example: 2024-01-12T23:59:59.999Z
    project stringrequired

    Project id of the project the impressions summary belong to

    Example: default
    totalRequests numberrequired

    Total number of times all project flags were requested

    Example: 50
    totalYes numberrequired

    Total number of times all project flags were exposed across all environments

    Example: 50
    totalNo numberrequired

    Total number of times all project flags were not exposed across all environments

    Example: 50
    totalApps numberrequired

    Total number of applications the impression data belong to

    Example: 50
    totalFlags numberrequired

    Total number of flags the impression data belong to

    Example: 50
    totalEnvironments numberrequired

    Total number of environments the impression data belong to

    Example: 50
  • ]

  • environmentTypeTrends

    object[]

    required

    How updates per environment type changed over time

  • Array [

  • date date-timerequired

    A UTC date when the stats were captured. Time is the very end of a given day.

    Example: 2024-01-12T23:59:59.999Z
    week stringrequired

    Year and week in a given year for which the stats were calculated

    Example: 2024-01
    environmentType stringrequired

    Environment type the data belongs too

    Example: production
    totalUpdates numberrequired

    Total number of times configuration has been updated in the environment type

    Example: 50
  • ]

Loading...