Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Monitoring Query & Overview
GETMonitoringSince 1.0SynchronousAuth Required

GetHealthScore

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • platformUuidStringRequired

    UUID of the platform to retrieve health score for

Responses

200 OK

On success, this API returns the following response structure.

  • platformUuidString

    UUID of the platform this health score belongs to

    Example: plat-001-abc

  • scoreLong

    Composite health score (0.0 – 100.0)

    Example: 95.5

  • availabilityLong

    Platform availability ratio (0.0 – 1.0)

    Example: 0.999

  • avgLatencyMsString

    Average API latency in milliseconds

    Example: 45

  • errorRateLong

    Error rate as a decimal fraction (0.0 – 1.0)

    Example: 0.002

  • gradeString

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

    Example: A

  • updatedAtString

    Updated at

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

Endpoint

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

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

Operation ID

GetHealthScore

Permalink

Request Example

curl -X GET '{host}/api/v1/monitoring/platform/{platformUuid}/health-score' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "platformUuid": "plat-001-abc",
  "score": 95.5,
  "availability": 0.999,
  "avgLatencyMs": 45,
  "errorRate": 0.002,
  "grade": "A",
  "updatedAt": "example"
}

Change History

This API has no change history records yet.

View all change history