web / lib/hooks/use-data-source-stats

lib/hooks/use-data-source-stats

React Query hook for fetching data source statistics.

Provides event counts per catalog and dataset for display in the DataSourceSelector component. Data is cached with a long stale time since total counts don’t change frequently.

Interfaces

DataSourceStatsResponse

Response format for data source stats endpoint.

Properties

catalogCounts

catalogCounts: Record<string, number>

datasetCounts

datasetCounts: Record<string, number>

totalEvents

totalEvents: number

Variables

dataSourceStatsQueryKey

const dataSourceStatsQueryKey: readonly ["data-source-stats"]

Query key for data source stats.

Functions

useDataSourceStatsQuery()

useDataSourceStatsQuery(): UseQueryResult<DataSourceStatsResponse, Error>

Hook to fetch event counts by catalog and dataset.

Returns total event counts for each catalog and dataset. These counts are independent of any filters and represent the total available data in each source.

Returns

UseQueryResult<DataSourceStatsResponse, Error>

Example


const { data: stats } = useDataSourceStatsQuery();
 
// Access counts
const catalogEventCount = stats?.catalogCounts["1"] ?? 0;
const datasetEventCount = stats?.datasetCounts["5"] ?? 0;