umami/src/components/hooks/queries/useWebsiteExpandedMetricsQuery.ts
2025-11-22 22:42:42 -08:00

51 lines
1.3 KiB
TypeScript

import { keepPreviousData } from '@tanstack/react-query';
import type { ReactQueryOptions } from '@/lib/types';
import { useApi } from '../useApi';
import { useDateParameters } from '../useDateParameters';
import { useFilterParameters } from '../useFilterParameters';
export type WebsiteExpandedMetricsData = {
name: string;
pageviews: number;
visitors: number;
visits: number;
bounces: number;
totaltime: number;
}[];
export function useWebsiteExpandedMetricsQuery(
websiteId: string,
params: { type: string; limit?: number; search?: string },
options?: ReactQueryOptions<WebsiteExpandedMetricsData>,
) {
const { get, useQuery } = useApi();
const { startAt, endAt, unit, timezone } = useDateParameters();
const filters = useFilterParameters();
return useQuery<WebsiteExpandedMetricsData>({
queryKey: [
'websites:metrics:expanded',
{
websiteId,
startAt,
endAt,
unit,
timezone,
...filters,
...params,
},
],
queryFn: async () =>
get(`/websites/${websiteId}/metrics/expanded`, {
startAt,
endAt,
unit,
timezone,
...filters,
...params,
}),
enabled: !!websiteId,
placeholderData: keepPreviousData,
...options,
});
}