🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.
import { Time } from "../../../components/DateSelector/types";
import { GetOverviewResponse } from "../endpoints";
import { useAnalyticsQuery } from "../useAnalyticsQuery";
type PeriodTime = "current" | "previous";
type UseGetOverviewOptions = {
periodTime?: PeriodTime;
site?: number | string;
overrideTime?: Time;
useFilters?: boolean;
// Read the MV-backed lite endpoint instead of the raw-events one.
lite?: boolean;
};
export function useGetOverview({
periodTime,
site,
overrideTime,
useFilters = true,
lite = false,
}: UseGetOverviewOptions) {
return useAnalyticsQuery<GetOverviewResponse>({
key: "overview",
path: lite ? "overview-lite" : "overview",
site,
periodTime,
overrideTime,
useFilters,
});
}