dots.v2.actionGateway.tools.health.tools.byTool_slug().get()
Generated on 13 Nov 2026
from DoTs version
v1.24.0
Usage
client.v2.actionGateway.tools.health.tools.byTool_slug(tool_slug).get(requestConfiguration?: RequestConfiguration<WithTool_slugItemRequestBuilderGetQueryParameters>): Promise<undefined | Get_tool_health_response>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
Path Parameters
tool_slugstring requiredExample:
exa_web_searchCatalog tool slug, for example
exa_search. Required.
Query Parameters
windowstring optionalWindow 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.includeHistoryboolean optionalExample:
trueAdditionally returns the window split into resolution-aligned points (the history field below).
Request Sample
Response Example
More Information
See /v2/action-gateway/tools/health/tools/{tool_slug} in the API reference for additional detail on responses, headers, parameters, and more.