Skip to content

feature: add recommendation conversion rate chart #3573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export const MessagesPerUser = ({
granularity={granularity}
date_range={filters.date_range}
xAxis={"time_stamp"}
yAxis={"messages_per_user"}
yAxis={"point"}
label="Messages Per User"
tooltipContent="The average number of messages a user sends in one session."
/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export const TopicCTRRate = ({
date_range={filters.date_range}
dataType="percentage"
xAxis={"time_stamp"}
yAxis={"ctr"}
yAxis={"point"}
label="CTR Rate"
tooltipContent="The rate at which users click on products within the chat sessions."
/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ export const TopicsUsage = ({
granularity: Granularity;
}) => {
const { trieve } = useTrieve();
const { data, isLoading } = useQuery(topicsUsageQuery(trieve, filters, granularity));
const { data, isLoading } = useQuery(
topicsUsageQuery(trieve, filters, granularity),
);

return (
<GraphComponent
Expand All @@ -23,7 +25,7 @@ export const TopicsUsage = ({
granularity={granularity}
date_range={filters.date_range}
xAxis={"time_stamp"}
yAxis={"topic_count"}
yAxis={"point"}
label="Chat Sessions Created"
tooltipContent="The total number of chat sessions that were created by users."
/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export const TotalUniqueVisitors = ({
graphData={data?.points}
granularity={granularity}
xAxis={"time_stamp"}
yAxis={"unique_users"}
yAxis={"point"}
dateRange={filters.date_range}
label="Total Unique Visitors"
tooltipContent="The total number of unique visitors to your store that interacted with the Trieve component."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export const RecommendationsCTRRate = ({
date_range={filters.date_range}
dataType="percentage"
xAxis={"time_stamp"}
yAxis={"ctr"}
yAxis={"point"}
label="CTR Rate"
tooltipContent="The rate at which users click on products after being recommended."
/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export const RecommendationsPerUser = ({
granularity={granularity}
date_range={filters.date_range}
xAxis={"time_stamp"}
yAxis={"recommendations_per_user"}
yAxis={"point"}
label="Recommendations Per User"
tooltipContent="The average number of recommendations a user receives in one session."
/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export const RecommendationsUsageChart = ({
granularity={granularity}
date_range={filters.date_range}
xAxis={"time_stamp"}
yAxis={"requests"}
yAxis={"point"}
label="Recommendations Usage"
tooltipContent="The total number of recommendations made by users."
/>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import { Box, Card, Text, Spinner } from "@shopify/polaris";
import { useQuery } from "@tanstack/react-query";
import { useTrieve } from "app/context/trieveContext";
import { RecommendationAnalyticsFilter, Granularity } from "trieve-ts-sdk";
import { GraphComponent } from "../GraphComponent";
import { recommendationConversionRateQuery } from "app/queries/analytics/recommendation";

export const RecommendationConversionRate = ({
filters,
granularity,
}: {
filters: RecommendationAnalyticsFilter;
granularity: Granularity;
}) => {
const { trieve } = useTrieve();
const { data, isLoading } = useQuery(
recommendationConversionRateQuery(trieve, filters, granularity),
);

return (
<GraphComponent
loading={isLoading}
topLevelMetric={data?.conversion_rate}
graphData={data?.points}
granularity={granularity}
date_range={filters.date_range}
dataType="percentage"
xAxis={"time_stamp"}
yAxis={"point"}
label="Recommendation Conversion Rate"
tooltipContent="The percentage of recommendations that led to cart additions or purchases."
/>
);
};
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ export const SearchCTRChart = ({
date_range={filters.date_range}
dataType="percentage"
xAxis={"time_stamp"}
yAxis={"ctr"}
label="CTR Rate"
tooltipContent="The rate at which users click on products within the chat sessions."
yAxis={"point"}
label="Search CTR Rate"
tooltipContent="The rate at which users click on products within the search sessions."
/>
);
}
};
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export const SearchConversionRate = ({
date_range={filters.date_range}
dataType="percentage"
xAxis={"time_stamp"}
yAxis={"conversion_rate"}
yAxis={"point"}
label="Search Conversion Rate"
tooltipContent="The percentage of searches that led to cart additions or purchases."
/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export const SearchUsageChart = ({
granularity={granularity}
date_range={filters.date_range}
xAxis={"time_stamp"}
yAxis={"requests"}
yAxis={"point"}
label="Search Usage"
tooltipContent="The total number of searches made by users."
/>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { QueryOptions } from "@tanstack/react-query";
import { TrieveSDK, RecommendationAnalyticsFilter, Granularity, RecommendationUsageGraphResponse, RecommendationsPerUserResponse, RecommendationsCTRRateResponse, RecommendationSortBy, RecommendationsEventResponse, SortOrder } from "trieve-ts-sdk";
import { TrieveSDK, RecommendationAnalyticsFilter, Granularity, RecommendationUsageGraphResponse, RecommendationsPerUserResponse, RecommendationsCTRRateResponse, RecommendationSortBy, RecommendationsEventResponse, SortOrder, RecommendationsConversionRateResponse } from "trieve-ts-sdk";

export const recommendationsUsageQuery = (
trieve: TrieveSDK,
Expand Down Expand Up @@ -79,4 +79,22 @@ export const allRecommendationsQuery = (
return result as RecommendationsEventResponse;
},
} satisfies QueryOptions;
};
};

export const recommendationConversionRateQuery = (
trieve: TrieveSDK,
filters: RecommendationAnalyticsFilter,
granularity: Granularity,
) => {
return {
queryKey: ["recommendationConversionRate", filters, granularity],
queryFn: async () => {
const result = await trieve.getRecommendationAnalytics({
filter: filters,
type: "recommendation_conversion_rate",
granularity: granularity,
});
return result as RecommendationsConversionRateResponse;
},
} satisfies QueryOptions;
};
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ import { RecommendationsUsageChart } from "app/components/analytics/recommendati
import { RecommendationsPerUser } from "app/components/analytics/recommendations/RecommendationsPerUser";
import { RecommendationsCTRRate } from "app/components/analytics/recommendations/RecommendationsCTRRate";
import { AllRecommendationsTable } from "app/components/analytics/recommendations/AllRecommendationsTable";
import { RecommendationConversionRate } from "app/components/analytics/recommendations/RecommnedationConversionRate";

export default function SearchAnalyticsPage() {
const [filters, setFilters] = useState(defaultSearchAnalyticsFilter);
const [granularity, setGranularity] = useState<Granularity>("day");
const [selectedTab, setSelectedTab] = useState(0);
return (
<>

<div className="-ml-2">
<Tabs
tabs={[
Expand Down Expand Up @@ -46,12 +46,26 @@ export default function SearchAnalyticsPage() {
/>
<Grid>
<Grid.Cell columnSpan={{ xs: 6, sm: 6, md: 6, lg: 6, xl: 6 }}>
<RecommendationsUsageChart filters={filters} granularity={granularity} />
<RecommendationsUsageChart
filters={filters}
granularity={granularity}
/>
<div className="py-3"></div>
<RecommendationsPerUser filters={filters} granularity={granularity} />
<RecommendationsPerUser
filters={filters}
granularity={granularity}
/>
</Grid.Cell>
<Grid.Cell columnSpan={{ xs: 6, sm: 6, md: 6, lg: 6, xl: 6 }}>
<RecommendationsCTRRate filters={filters} granularity={granularity} />
<RecommendationsCTRRate
filters={filters}
granularity={granularity}
/>
<div className="py-3"></div>
<RecommendationConversionRate
filters={filters}
granularity={granularity}
/>
</Grid.Cell>
</Grid>
</>
Expand Down
Loading
Loading