Skip to main content

​
useApiAuthAuditTimeseries

The useApiAuthAuditTimeseries hook returns interval-based API auth audit metrics.

​
Parameters

​
options.start_date
string
ISO start date.
​
options.end_date
string
ISO end date.
​
options.interval
string
Aggregation interval (for example hour or day).
​
options.key_id
string
Optional key filter.

​
Return Value

​
timeseries
ApiAuditTimeseriesResponse['data']
Timeseries points.
​
interval
string
Applied interval.
​
loading
boolean
Whether request is in progress.
​
error
unknown
Error from the latest request.
​
refetch
() => void
Revalidate timeseries.

​
Example

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

function ApiAuthTrend() {
  const { timeseries } = useApiAuthAuditTimeseries({ interval: "day" });
  return <pre>{JSON.stringify(timeseries, null, 2)}</pre>;
}