Skip to main content
ZStack
Monitoring & Collection/Scrape Collection

GetScrapeHealthSummary

Get a summary of scrape health across all targets (up, down, unknown, maintenance counts)

GET/api/v1/monitoring/scrape-health/summary

Operation ID

GetScrapeHealthSummary

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

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • totalTargets
    Integer

    Total number of registered scrape targets

    Example: 20

  • up
    Integer

    Number of targets currently in an up (healthy) state

    Example: 17

  • down
    Integer

    Number of targets currently in a down (unhealthy) state

    Example: 2

  • unknown
    Integer

    Number of targets with an unknown health state

    Example: 20

  • maintenance
    Integer

    Number of targets currently under maintenance

    Example: 1

  • lastUpdated
    String

    Last updated

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