wp-calypso/client/my-sites/stats/hooks/use-utm-metrics-query.ts

import { useEffect } from 'react';
import { useDispatch, useSelector } from 'calypso/state';
import { getSiteSlug } from 'calypso/state/sites/selectors';
import { requestMetrics } from 'calypso/state/stats/utm-metrics/actions';
import { getMetrics, isLoading } from 'calypso/state/stats/utm-metrics/selectors';

export default function useUTMMetricsQuery(
	siteId: number,
	UTMParam: string,
	query: object,
	postId?: number
) {
	const dispatch = useDispatch();
	const siteSlug = useSelector( ( state ) => getSiteSlug( state, siteId ) ) as string;

	// The query object is used as a dependency for the effect,
	// so it needs to be stringified.
	const queryKey = JSON.stringify( query );
	useEffect( () => {
		dispatch( requestMetrics( siteId, UTMParam, query, postId, siteSlug ) );
		// eslint-disable-next-line react-hooks/exhaustive-deps
	}, [ dispatch, siteId, UTMParam, queryKey, postId, siteSlug ] );

	const isFetching = useSelector( ( state ) => isLoading( state, siteId ) );
	const metrics = useSelector( ( state ) => getMetrics( state, siteId, postId ) );

	return {
		isFetching,
		metrics,
	};
}