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

GetPlatformOverview

Get a consolidated platform overview including runtime health metrics.

Execution Availability

Try It Out

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

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • collectedAtString

    Collected at

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

  • overallStatusString

    Overall health status of the platform process

    Example: healthy

  • databaseJsonString

    JSON-serialized database health details

    Example: {"connected": true, "latency_ms": 5}

  • eventsubJsonString

    JSON-serialized event subscription subsystem health

    Example: {"active_subs": 12}

  • goroutinesJsonString

    JSON-serialized goroutine runtime statistics

    Example: {"count": 48}

Endpoint

GET/api/v1/monitoring/platform-overview

/api/v1/monitoring/platform-overview

Operation ID

GetPlatformOverview

Permalink

Request Example

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

Response Example

200
{
  "collectedAt": "example",
  "overallStatus": "healthy",
  "databaseJson": "{\"connected\": true, \"latency_ms\": 5}",
  "eventsubJson": "{\"active_subs\": 12}",
  "goroutinesJson": "{\"count\": 48}"
}

Change History

This API has no change history records yet.

View all change history