Get application overview

GET 
<your-unleash-url>/api/admin/metrics/applications/:appName/overview

Returns an overview of the specified application (appName).

Request

Path Parameters

appName stringrequired

Responses

200

applicationOverviewSchema

application/json

Schema

Schema

projectsstring[]required
The list of projects the application has been using.
Example: ["default","payment"]
featureCountnumberrequired
The number of features the application has been using.
Example: 5
environments object[]required
The list of environments the application has been using.
Array [
namestringrequired
Name of the application environment
Example: production
instanceCountnumberrequired
The number of instances of the application environment
Example: 5
sdksstring[]required
SDKs used in the application environment
Example: ["unleash-client-node:5.4.0","unleash-client-node:5.3.0"]
lastSeendate-timenullablerequired
The last time the application environment was seen
Example: 2023-04-19T08:15:14.000Z
issues objectrequired
This list of issues that might be wrong with the application
missingFeaturesstring[]required
The list of features that are missing in Unleash
Example: ["feature1","feature2"]
outdatedSdksstring[]required
The list of used SDKs that are outdated
Example: ["unleash-client-node:5.4.0","unleash-client-node:5.3.0"]
]
issues objectrequired
This list of issues that might be wrong with the application
missingStrategiesstring[]required
The list of strategies that are missing from Unleash
Example: ["feature1","feature2"]

Example (auto)

{
  "projects": [
    "default",
    "payment"
  ],
  "featureCount": 5,
  "environments": [
    {
      "name": "production",
      "instanceCount": 5,
      "sdks": [
        "unleash-client-node:5.4.0",
        "unleash-client-node:5.3.0"
      ],
      "lastSeen": "2023-04-19T08:15:14.000Z",
      "issues": {
        "missingFeatures": [
          "feature1",
          "feature2"
        ],
        "outdatedSdks": [
          "unleash-client-node:5.4.0",
          "unleash-client-node:5.3.0"
        ]
      }
    }
  ],
  "issues": {
    "missingStrategies": [
      "feature1",
      "feature2"
    ]
  }
}

404

The requested resource was not found.

application/json

Schema

Schema

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

Example (auto)

{
  "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 '<your-unleash-url>/api/admin/metrics/applications/:appName/overview' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

appName — pathrequired

ResponseClear

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