Get application data

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

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Returns data about the specified application (appName). The data contains information on the name of the application, sdkVersion (which sdk reported these metrics, typically unleash-client-node:3.4.1 or unleash-client-java:7.1.0), as well as data about how to display this application in a list.

Request

Path Parameters

• appName string required

Responses

• 200
• 404

---

applicationSchema

application/json

Schema

Schema

• appName string required

  Name of the application

• sdkVersion string

  Which SDK and version the application reporting uses. Typically represented as <identifier>:<version>

• strategies string[]

  Which strategies the application has loaded. Useful when trying to figure out if your custom strategy has been loaded in the SDK

• description string

  Extra information added about the application reporting the metrics. Only present if added via the Unleash Admin interface

• url string

  A link to reference the application reporting the metrics. Could for instance be a GitHub link to the repository of the application

• color string

  The CSS color that is used to color the application's entry in the application list

• icon string

  An URL to an icon file to be used for the applications's entry in the application list

• usage object[]

  The list of projects the application has been using.

  Array [

  project string required

  Name of the project

  environments string[] required

  Which environments have been accessed in this project.

  ]

Example (from schema)

{
  "appName": "accounting",
  "sdkVersion": "unleash-client-java:8.0.0",
  "strategies": [
    "standard",
    "gradualRollout",
    "mySpecialCustomStrategy"
  ],
  "description": "Application for reporting page visits",
  "url": "https://github.com/Unleash/unleash-proxy-client-js",
  "color": "red",
  "icon": "https://github.com/favicon.ico",
  "usage": [
    {
      "project": "main-project",
      "environments": [
        "development",
        "production"
      ]
    }
  ]
}

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

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Request

Base URL

<your-unleash-url>

Security Scheme

apiKeybearerToken

apiKey

appName — path required

curl / cURL

curl -L -X GET '<your-unleash-url>/api/admin/metrics/applications/:appName' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

python / requests

curl -L -X GET '<your-unleash-url>/api/admin/metrics/applications/:appName' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

go / native

curl -L -X GET '<your-unleash-url>/api/admin/metrics/applications/:appName' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

nodejs / axios

curl -L -X GET '<your-unleash-url>/api/admin/metrics/applications/:appName' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

ruby / Net::HTTP

curl -L -X GET '<your-unleash-url>/api/admin/metrics/applications/:appName' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

csharp / RestSharp

curl -L -X GET '<your-unleash-url>/api/admin/metrics/applications/:appName' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

php / cURL

curl -L -X GET '<your-unleash-url>/api/admin/metrics/applications/:appName' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

java / OkHttp

curl -L -X GET '<your-unleash-url>/api/admin/metrics/applications/:appName' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

powershell / RestMethod

curl -L -X GET '<your-unleash-url>/api/admin/metrics/applications/:appName' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'