How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Unleash Metrics API

Register, read, or delete metrics recorded by Unleash.

Unleash Metrics API is one of 36 APIs that Unleash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Metrics. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 13 operations across 11 paths, and defines 17 schemas. It is described by OpenAPI 3.0.3, at version 7.4.1.

Requests are made against a single base URL, https://app.unleash-instance.example.com.

13 operations 11 paths 17 schemas 1 DELETE11 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
7.4.1
Base URL
https://app.unleash-instance.example.com
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Unleash Metrics API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiKey). It accepts HTTP bearer tokens (bearerToken). By default, every request must be authenticated.

  • apiKey — API key needed to access this API
  • bearerToken — API key needed to access this API, in Bearer token format

Paths & Operations 13

Across 11 paths, the API surfaces 13 operations — 1 DELETE, 11 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Metrics 13

Register, read, or delete metrics recorded by Unleash.

GET
/api/admin/metrics/rps
Gets Usage Data
getRequestsPerSecond → 200
GET
/api/admin/metrics/traffic
Get Aggregated Traffic Data for a Given Time Period.
getTrafficDataUsageForPeriod 3 params → 200
POST
/api/admin/metrics/applications/{appName}
Create an Application to Connect Reported Metrics
createApplication 1 param body → 202400401403
DELETE
/api/admin/metrics/applications/{appName}
Delete an Application
deleteApplication 1 param → 200401403
GET
/api/admin/metrics/applications/{appName}
Get Application Data
getApplication 1 param → 200404
GET
/api/admin/metrics/applications
Get All Applications
getApplications 5 params → 200
GET
/api/admin/metrics/applications/{appName}/overview
Get Application Overview
getApplicationOverview 1 param → 200404
GET
/api/admin/metrics/instances/{appName}/environment/{environment}
Get Application Environment Instances (last 24h)
getApplicationEnvironmentInstances 2 params → 200404
GET
/api/admin/metrics/sdks/outdated
Get Outdated Sdks
getOutdatedSdks → 200404
GET
/api/admin/client-metrics/features/{name}/raw
Get Feature Metrics
getRawFeatureMetrics 1 param → 200401403404
GET
/api/admin/client-metrics/features/{name}
Last Hour of Usage and a List of Applications That Have Reported Seeing This Feature Flag
getFeatureUsageSummary 1 param → 200401403404
GET
/api/admin/custom-metrics
Get Stored Custom Metrics
getCustomMetrics → 200
GET
/api/admin/custom-metrics/prometheus
Get Metrics in Prometheus Format
getPrometheusMetrics → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are applicationSchema (8 properties), applicationOverviewEnvironmentSchema (7 properties), featureEnvironmentMetricsSchema (7 properties), featureUsageSchema (5 properties). Each schema is shown below with its type and property counts.

trafficUsageDataSegmentedCombinedSchema
object
Contains the recorded data usage for each API path, segmented by day/month and type of traffic
3 properties 3 required
applicationOverviewEnvironmentSchema
object
Data about an application environment
7 properties 7 required
featureUsageSchema
object
How many applications have seen this feature flag, as well as how this feature was evaluated the last hour
5 properties 5 required
featureMetricsSchema
object
A batch of feature metrics
3 properties 3 required
applicationsSchema
object
An object containing a list of applications that have connected to Unleash via an SDK.
2 properties 2 required
applicationEnvironmentInstancesSchema
object
Data about an application environment instances that are connected to Unleash via an SDK.
1 property 1 required
createApplicationSchema
object
Reported application information from Unleash SDKs
4 properties
requestsPerSecondSchema
object
Statistics for usage of Unleash, formatted so it can easily be used in a graph
2 properties
applicationSchema
object
Data about an application that's connected to Unleash via an SDK.
8 properties 1 required
outdatedSdksSchema
object
Data about outdated SDKs that should be upgraded.
1 property 1 required
applicationUsageSchema
object
Data about an project that have been used by applications.
2 properties 2 required
applicationEnvironmentIssuesSchema
object
This list of issues that might be wrong with the application
2 properties 2 required
featureEnvironmentMetricsSchema
object
How many times feautreName was evaluated to true (yes) and false (no) for appName in environmnet
7 properties 4 required
applicationOverviewIssuesSchema
object
This list of issues that might be wrong with the application
1 property 1 required
applicationOverviewSchema
object
Data about an application that's connected to Unleash via an SDK.
4 properties 4 required
requestsPerSecondSegmentedSchema
object
Get usage metrics separated by client and admin paths
2 properties
dateSchema
A representation of a date. Either as a date-time string or as a UNIX timestamp.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

unleash-metrics-api-openapi.yml Raw ↑

Other APIs Unleash publishes across the network.

Unleash Client API
Unleash Addons API
Unleash Admin UI API
Unleash API tokens API
Unleash Archive API
Unleash Auth API
Unleash Banners API
Unleash Change Requests API
Unleash Context API
Unleash Dependencies API
Unleash Environments API
Unleash Events API
Where this information came from

This is an independent, third-party profile of Unleash Metrics API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.