Skip to main content
ZStack
Monitoring & Collection/Monitoring Query & Overview

GetHealthScore

Retrieve the current health score for a platform based on availability and latency metrics

GET/api/v1/monitoring/platform/{platformUuid}/health-score

Operation ID

GetHealthScore

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • platformUuid
    StringRequired

    UUID of the platform to retrieve health score for

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • platformUuid
    String

    UUID of the platform this health score belongs to

    Example: plat-001-abc

  • score
    Long

    Composite health score (0.0 – 100.0)

    Example: 95.5

  • availability
    Long

    Platform availability ratio (0.0 – 1.0)

    Example: 0.999

  • avgLatencyMs
    String

    Average API latency in milliseconds

    Example: 45

  • errorRate
    Long

    Error rate as a decimal fraction (0.0 – 1.0)

    Example: 0.002

  • grade
    String

    Human-readable health grade (A, B, C, D, F)

    Example: A

  • updatedAt
    String

    Updated at

    Example: 2026-01-15T08:00:00Z