Give Feedback

pydo.tools.get_health()

Generated on 1 Oct 2026 from pydo version v0.43.0

Copy page as Markdown View page as Markdown

Usage

client.tools.get_health(
    tool_slug="exa_web_search",
    window="HEALTH_WINDOW_TWENTY_FOUR_HOURS",
    include_history=False,
)

Returns JSONRaises HttpResponseError

Description

Returns availability and latency for one catalog tool over the requested window, optionally with a history series. Metrics are aggregated across all customers; request volumes are not reported. Returns 404 when tool_slug is not a catalog tool.

Parameters

tool_slug string required

Catalog tool slug, for example exa_search. Required.

window string optional

Window to aggregate over. Defaults to twenty-four hours.

- HEALTH_WINDOW_UNSPECIFIED: Twenty-four hours.
- HEALTH_WINDOW_ONE_HOUR: One hour; history points are 10 minutes.
- HEALTH_WINDOW_TWENTY_FOUR_HOURS: Twenty-four hours; history points are 1 hour.
- HEALTH_WINDOW_SEVEN_DAYS: Seven days; history points are 6 hours.
- HEALTH_WINDOW_THIRTY_DAYS: Thirty days; history points are 24 hours.

One of: HEALTH_WINDOW_ONE_HOUR, HEALTH_WINDOW_TWENTY_FOUR_HOURS, HEALTH_WINDOW_SEVEN_DAYS, HEALTH_WINDOW_THIRTY_DAYS

Default: HEALTH_WINDOW_TWENTY_FOUR_HOURS

include_history boolean optional

Additionally returns the window split into resolution-aligned points (the history field below).

Default: False

Response Example

Show Response Example

{
  "snapshot": {
    "measured_at": "2026-09-24T12:00:00Z",
    "window": "3600s",
    "stale": false
  },
  "tool": {
    "tool_slug": "exa_web_search",
    "provider": "exa",
    "health": {
      "data_status": "HEALTH_DATA_STATUS_AVAILABLE",
      "uptime_percentage": 99.82,
      "latency_p50_ms": 412.5,
      "latency_p95_ms": 1180
    }
  },
  "history": {
    "resolution": "600s",
    "stale": false,
    "points": [
      {
        "bucket_start": "2026-09-24T11:10:00Z",
        "health": {
          "data_status": "HEALTH_DATA_STATUS_AVAILABLE",
          "uptime_percentage": 99.82,
          "latency_p50_ms": 412.5,
          "latency_p95_ms": 1180
        }
      },
      {
        "bucket_start": "2026-09-24T11:20:00Z",
        "health": {
          "data_status": "HEALTH_DATA_STATUS_NO_DATA",
          "uptime_percentage": null,
          "latency_p50_ms": null,
          "latency_p95_ms": null
        }
      }
    ]
  }
}

More Information

See /v2/action-gateway/tools/health/tools/{tool_slug} in the API reference for additional detail on responses, headers, parameters, and more.