---
title: "Register Edge observability metrics."
method: POST
path: "/api/client/metrics/edge"
tags: ["Unleash Edge"]
---

# Register Edge observability metrics.

`POST /api/client/metrics/edge`

**Enterprise feature**

Registers Edge observability metrics from downstream Edge instances to aggregate a comprehensive status view of connected Edges.

## Request body

- EdgeInstanceDataSchema — Represents Edge instance observability data.
  - `identifier` string, required — The ID of the Edge process, typically a ULID. Newly generated for each restart of the instance.
  - `appName` string, required — The name of the application, configured by the user, typically persistent across restarts of Edge.
  - `region` string, nullable — Which region the Edge instance is running in. Set to AWS_REGION by default (if present).
  - `edgeVersion` string, required — Which version (semver) of Edge is the Edge instance running.
  - `processMetrics` EdgeProcessMetricsSchema — Represents Edge instance resource usage data.
    - `cpuUsage` number, required — CPU usage, in seconds, since start of process.
    - `memoryUsage` number, required — Current process_resident_memory (in bytes) usage.
  - `started` string, date-time, required — RFC3339 timestamp for when the Edge instance was started.
  - `traffic` EdgeInstanceTrafficSchema, required — Represents requests to the Edge instance (/api/client/features, /api/frontend, etc.)
    - `get` object, required — A map containing GET requests.
    - `post` object, required — A map containing POST requests.
    - `accessDenied` object, required — A map containing requests that were denied.
    - `cachedResponses` object, required — A map containing requests that had cached responses.
  - `latencyUpstream` EdgeUpstreamLatencySchema, required — Latencies for upstream actions from Edge (downloading/syncing new features, uploading metrics, uploading instance data)
    - `features` EdgeLatencyMetricsSchema, required — Representing latency for an Edge operation.
      - `avg` number, required — Average time per request in milliseconds.
      - `count` number, required — Total number of requests made.
      - `p99` number, required — 99% of requests finished within this amount of milliseconds.
    - `metrics` EdgeLatencyMetricsSchema, required — Representing latency for an Edge operation.
      - `avg` number, required — Average time per request in milliseconds.
      - `count` number, required — Total number of requests made.
      - `p99` number, required — 99% of requests finished within this amount of milliseconds.
    - `edge` EdgeLatencyMetricsSchema, required — Representing latency for an Edge operation.
      - `avg` number, required — Average time per request in milliseconds.
      - `count` number, required — Total number of requests made.
      - `p99` number, required — 99% of requests finished within this amount of milliseconds.
  - `connectedStreamingClients` number, required — How many streaming clients are connected to the Edge instance.
  - `connectedEdges` EdgeInstanceDataSchema[], required — A list of Edge instances connected to the Edge instance.
  - `requestsSinceLastReport` EdgeRequestStatsSchema — Represents Edge traffic data.
    - `/api/client/features` EdgeEndpointTrafficSchema — Represents traffic data for a single endpoint in Edge
      - `requests200` number — Number of 20x requests
      - `requests304` number — Number of 30x requests
    - `/api/frontend` EdgeEndpointTrafficSchema — Represents traffic data for a single endpoint in Edge
      - `requests200` number — Number of 20x requests
      - `requests304` number — Number of 30x requests
    - `/api/proxy` EdgeEndpointTrafficSchema — Represents traffic data for a single endpoint in Edge
      - `requests200` number — Number of 20x requests
      - `requests304` number — Number of 30x requests
    - `/api/client/metrics` EdgeEndpointTrafficSchema — Represents traffic data for a single endpoint in Edge
      - `requests200` number — Number of 20x requests
      - `requests304` number — Number of 30x requests
    - `/api/client/metrics/bulk` EdgeEndpointTrafficSchema — Represents traffic data for a single endpoint in Edge
      - `requests200` number — Number of 20x requests
      - `requests304` number — Number of 30x requests
    - `/api/client/metrics/edge` EdgeEndpointTrafficSchema — Represents traffic data for a single endpoint in Edge
      - `requests200` number — Number of 20x requests
      - `requests304` number — Number of 30x requests
  - `connectionConsumptionSinceLastReport` ConnectionConsumptionSchema
    - `features` MeteredGroupConsumptionSchema[], required — Feature consumption data points
      - `meteredGroup` string, required — Name of the metered group
      - `dataPoints` ConsumptionDataPointSchema[], required — Array of consumption data points
        - `interval` integer[], required — Time interval in milliseconds [start, end].
        - `requests` number, required — Number of requests in this interval
    - `metrics` MeteredGroupConsumptionSchema[], required — Metrics consumption data points
      - `meteredGroup` string, required — Name of the metered group
      - `dataPoints` ConsumptionDataPointSchema[], required — Array of consumption data points
        - `interval` integer[], required — Time interval in milliseconds [start, end].
        - `requests` number, required — Number of requests in this interval
  - `requestConsumptionSinceLastReport` object[]
    - `meteredGroup` string, required — Name of the metered group
    - `requests` number, required — Total number of requests for this metered group
  - `hosting` 'hosted' | 'self-hosted' | 'enterprise-self-hosted' — A marker that tells Unleash whether this Edge instance is self-hosted, enterprise self-hosted, or hosted by Unleash.
  - `apiKeyRevisionIds` EdgeApiKeyRevisionIdSchema[], nullable — List of API keys (represented by their environment and projects) and revision ids to make it easier to track sync state of edge
    - `environment` string, required — The Unleash Environment this apiKey is synced for
    - `projects` string[], required — The list of projects this key is valid for or * if valid for all projects
    - `revisionId` number, required — The revision id of Edge's last successful sync of this key
    - `lastUpdated` string, date-time — The timestamp of the last successful sync of this key

## Response `202`

This response has no body.

---

[API](https://skmtc.net/unleash/apis/unleash-api-3.md) · [All operations](https://skmtc.net/unleash/apis/unleash-api-3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unleash/unleash-api-3/revisions/b2c3116e633e/schema)