Skip to main content
GET
/
v1
/
analytics
/
tools
/
dashboard
Combined tool analytics dashboard envelope
curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/analytics/tools/dashboard \
  --header 'x-api-key: <api-key>'
{
  "summary": [
    {
      "current_invocations": 123,
      "previous_invocations": 123,
      "pct_change_invocations": 123,
      "current_errors": 123,
      "previous_errors": 123,
      "pct_change_errors": 123,
      "current_success_rate": 123,
      "previous_success_rate": 123,
      "pct_change_success_rate": 123,
      "current_avg_latency_ms": 123,
      "previous_avg_latency_ms": 123,
      "pct_change_avg_latency_ms": 123,
      "current_p95_latency_ms": 123,
      "previous_p95_latency_ms": 123,
      "pct_change_p95_latency_ms": 123,
      "current_active_tools": 123,
      "previous_active_tools": 123,
      "pct_change_active_tools": 123
    }
  ],
  "top_tools": [
    {
      "tool_id": "<string>",
      "tool_name": "<string>",
      "tool_type": "<string>",
      "invocations": 123,
      "error_count": 123,
      "success_rate_pct": 123,
      "avg_latency_ms": 123,
      "provider": "<string>"
    }
  ],
  "health_matrix": [
    {
      "tool_id": "<string>",
      "tool_name": "<string>",
      "tool_type": "<string>",
      "invocation_count": 123,
      "current_error_rate": 123,
      "previous_error_rate": 123,
      "error_trend_delta": 123,
      "success_rate_score": 123,
      "latency_score": 123,
      "error_trend_score": 123,
      "health_score": 123,
      "success_rate": 123,
      "p95_latency_ms": 123
    }
  ],
  "recent_errors": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "tool_id": "<string>",
      "tool_name": "<string>",
      "tool_type": "<string>",
      "error_category": "<string>",
      "latency_ms": 123,
      "provider": "<string>",
      "agent_id": "<string>",
      "session_id": "<string>",
      "status_code": 123,
      "error_message": "<string>"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Query Parameters

tool_type
string | null
revision_id
string | null
top_tools_limit
integer
default:10
Required range: 1 <= x <= 100
health_matrix_limit
integer
default:50
Required range: 1 <= x <= 200
recent_errors_limit
integer
default:20
Required range: 1 <= x <= 100
min_invocations
integer
default:10
Required range: x >= 1
latency_ceiling_ms
number
default:5000
start_date
string<date>
required
end_date
string<date>
required

Response

Successful Response

Combined dashboard payload — one envelope, four pre-aggregated panels.

summary is at most one row but the underlying pipe returns a list, so we keep it as a (possibly empty) list rather than special-casing it on the client.

summary
DashboardSummaryRow · object[]
required
top_tools
DashboardTopToolsRow · object[]
required
health_matrix
DashboardHealthMatrixRow · object[]
required
recent_errors
DashboardRecentErrorRow · object[]
required