Skip to main content

​
useApiAuthAuditAnalytics

The useApiAuthAuditAnalytics hook returns aggregated analytics for API auth requests.

​
Parameters

​
options.start_date
string
ISO start date.
​
options.end_date
string
ISO end date.
​
options.key_id
string
Optional key filter.
​
options.include_top_keys
boolean
Include top keys breakdown.
​
options.include_top_paths
boolean
Include top endpoint paths.
​
options.include_blocked_reasons
boolean
Include blocked reason stats.
​
options.include_rate_limits
boolean
Include rate-limit breakdown.
​
options.top_limit
number
Limit for top-N aggregations.

​
Return Value

​
analytics
ApiAuditAnalyticsResponse | null
Aggregated analytics payload.
​
loading
boolean
Whether request is in progress.
​
error
unknown
Error from the latest request.
​
refetch
() => void
Revalidate analytics.

​
Example

import { useApiAuthAuditAnalytics } from "@wacht/react-router";

function ApiAuthCharts() {
  const { analytics, loading } = useApiAuthAuditAnalytics({ include_top_paths: true });
  if (loading) return <div>Loading...</div>;
  return <pre>{JSON.stringify(analytics, null, 2)}</pre>;
}