Skip to main content
API Explorer|API Explorer
Platform Operations/Platforms
GETPlatformSince 1.0SynchronousAuth Required

GetHealthStats

Get aggregated health statistics including pass rate and average latency.

Execution Availability

Try It Out

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

Path Parameters

Query Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    UUID of the platform to get statistics for

Query Parameters

  • daysInteger

    Number of days of historical data to include in the statistics Number of days of historical data to include in the statistics

    Example: 0

Responses

200 OK

On success, this API returns the following response structure.

  • totalChecksInteger

    Total number of health checks executed

    Example: 100

  • passedChecksInteger

    Number of health checks that passed

    Example: 95

  • failedChecksInteger

    Number of health checks that failed

    Example: 5

  • healthRateLong

    Percentage of checks that passed (0.0 to 1.0)

    Example: 0.95

  • avgLatencyMsString

    Average latency in milliseconds across all checks

    Example: 85

Endpoint

GET/api/v1/platforms/{uuid}/health-stats

/api/v1/platforms/{uuid}/health-stats

Operation ID

GetHealthStats

Permalink

Request Example

curl -X GET '{host}/api/v1/platforms/{uuid}/health-stats' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "totalChecks": 100,
  "passedChecks": 95,
  "failedChecks": 5,
  "healthRate": 0.95,
  "avgLatencyMs": 85
}

Change History

This API has no change history records yet.

View all change history