The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.
TypeScript clickhousemysqlnextjsopen-sourceplanetscaleprismatailwindcsstinybirdtypescriptupstashvercel
Add `eventName` filter in analytics
Steven Teyc86f7074e809
diff --git a/apps/web/lib/analytics/constants.ts b/apps/web/lib/analytics/constants.tsindex 2fd7c7b5a6..50dee089d0 100644--- a/apps/web/lib/analytics/constants.ts+++ b/apps/web/lib/analytics/constants.ts@@ -73,6 +73,7 @@ export const VALID_ANALYTICS_ENDPOINTS = ["os","trigger", // deprecated, but keeping for now for backwards compatibility"triggers",+ "event_names","referers","referer_urls","top_folders",@@ -103,6 +104,7 @@ export const SINGULAR_ANALYTICS_ENDPOINTS = {referer_urls: "refererUrl",os: "os",triggers: "trigger",+ event_names: "eventName",utm_sources: "utm_source",utm_mediums: "utm_medium",utm_campaigns: "utm_campaign",@@ -142,6 +144,7 @@ export const VALID_ANALYTICS_FILTERS = ["browser","os","trigger",+ "eventName","referer","refererUrl","url",@@ -167,6 +170,7 @@ export const DIMENSIONAL_ANALYTICS_FILTERS = ["browser","os","trigger",+ "eventName","referer","refererUrl","url",diff --git a/apps/web/lib/analytics/filter-helpers.ts b/apps/web/lib/analytics/filter-helpers.tsindex 2cb312e9d1..c70da0f538 100644--- a/apps/web/lib/analytics/filter-helpers.ts+++ b/apps/web/lib/analytics/filter-helpers.ts@@ -149,6 +149,7 @@ const SUPPORTED_FIELDS = ["refererUrl","url","trigger",+ "eventName","utm_source","utm_medium","utm_campaign",diff --git a/apps/web/lib/openapi/analytics/index.ts b/apps/web/lib/openapi/analytics/index.tsindex d2ef6887a4..21c36cefd3 100644--- a/apps/web/lib/openapi/analytics/index.ts+++ b/apps/web/lib/openapi/analytics/index.ts@@ -68,6 +68,11 @@ const retrieveAnalytics: ZodOpenApiOperationObject = {id: "AnalyticsTriggers",}),),+ z.array(+ analyticsResponse.event_names.meta({+ id: "AnalyticsEventNames",+ }),+ ),z.array(analyticsResponse.referers.meta({id: "AnalyticsReferers",diff --git a/apps/web/lib/zod/schemas/analytics-response.ts b/apps/web/lib/zod/schemas/analytics-response.tsindex 2305bafbf9..89c0291b42 100644--- a/apps/web/lib/zod/schemas/analytics-response.ts+++ b/apps/web/lib/zod/schemas/analytics-response.ts@@ -204,6 +204,27 @@ export const analyticsResponse = {triggers: analyticsTriggersResponse,trigger: analyticsTriggersResponse, // backwards compatibility+ event_names: z.object({+ eventName: z+ .string()+ .describe("The name of the conversion event (lead or sale)"),+ clicks: z+ .number()+ .describe("The number of clicks from this event name")+ .default(0),+ leads: z+ .number()+ .describe("The number of leads from this event name")+ .default(0),+ sales: z+ .number()+ .describe("The number of sales from this event name")+ .default(0),+ saleAmount: centsSchemaWithDefault.describe(+ "The total amount of sales from this event name, in cents",+ ),+ }),+referers: z.object({referer: z.string()diff --git a/apps/web/lib/zod/schemas/analytics.ts b/apps/web/lib/zod/schemas/analytics.tsindex 1b2fafae96..69bea88860 100644--- a/apps/web/lib/zod/schemas/analytics.ts+++ b/apps/web/lib/zod/schemas/analytics.ts@@ -277,6 +277,15 @@ export const analyticsQuerySchema = z.object({"Examples: `qr`, `qr,link`, `-qr`. " +"If undefined, returns all trigger types.",),+ eventName: z+ .string()+ .optional()+ .transform(parseFilterValue)+ .describe(+ "The conversion event name to retrieve analytics for. Only available for lead and sale events. " ++ "Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). " ++ "Examples: `Sign up`, `Sign up,Purchase`, `-Sign up`.",+ ),referer: z.string().optional()diff --git a/apps/web/tests/analytics/advanced-filter-helpers.test.ts b/apps/web/tests/analytics/advanced-filter-helpers.test.tsindex 90134467c9..ad4b5b5ee0 100644--- a/apps/web/tests/analytics/advanced-filter-helpers.test.ts+++ b/apps/web/tests/analytics/advanced-filter-helpers.test.ts@@ -294,6 +294,23 @@ describe("Advanced Filters - Unit Tests", () => {]);});+ test("eventName field", () => {+ const result = buildAdvancedFilters({+ eventName: {+ operator: "IS_ONE_OF",+ sqlOperator: "IN",+ values: ["Sign up", "Purchase"],+ },+ });+ expect(result).toEqual([+ {+ field: "eventName",+ operator: "IN",+ values: ["Sign up", "Purchase"],+ },+ ]);+ });+test("maintains insertion order", () => {const result = buildAdvancedFilters({device: { operator: "IS", sqlOperator: "IN", values: ["Mobile"] },diff --git a/apps/web/tests/analytics/export-analytics-to-zip.test.ts b/apps/web/tests/analytics/export-analytics-to-zip.test.tsindex 46e2de9658..71d3bdbd30 100644--- a/apps/web/tests/analytics/export-analytics-to-zip.test.ts+++ b/apps/web/tests/analytics/export-analytics-to-zip.test.ts@@ -96,6 +96,7 @@ describe("export-analytics-to-zip", () => {"os","trigger","triggers",+ "event_names","referers","referer_urls","top_folders",@@ -144,6 +145,7 @@ describe("export-analytics-to-zip", () => {"os","trigger","triggers",+ "event_names","referers","referer_urls","top_folders",diff --git a/apps/web/ui/analytics/events/events-table.tsx b/apps/web/ui/analytics/events/events-table.tsxindex 32ffa96fb4..2fbf5aab1e 100644--- a/apps/web/ui/analytics/events/events-table.tsx+++ b/apps/web/ui/analytics/events/events-table.tsx@@ -253,6 +253,11 @@ export default function EventsTable({id: "event",header: "Event",accessorKey: "eventName",+ meta: {+ filterParams: ({ getValue }) => ({+ eventName: getValue(),+ }),+ },cell: ({ getValue }) =>getValue() ? (<span className="truncate" title={getValue()}>diff --git a/apps/web/ui/analytics/use-analytics-filters.tsx b/apps/web/ui/analytics/use-analytics-filters.tsxindex e9041b57be..5eb07f4ab0 100644--- a/apps/web/ui/analytics/use-analytics-filters.tsx+++ b/apps/web/ui/analytics/use-analytics-filters.tsx@@ -17,6 +17,7 @@ import {UTM_PARAMETERS,} from "@dub/ui";import {+ Bolt,Calendar6,Cube,CursorRays,@@ -339,6 +340,11 @@ export function useAnalyticsFilters({omitGroupByFilterKey: true,context,});+ const { data: eventNames } = useAnalyticsFilterOption("event_names", {+ disabled: !isRequested("eventName") || selectedTab === "clicks",+ omitGroupByFilterKey: true,+ context,+ });const { data: referers } = useAnalyticsFilterOption("referers", {disabled: !isRequested("referer"),omitGroupByFilterKey: true,@@ -771,6 +777,18 @@ export function useAnalyticsFilters({separatorAfter: true,},]),+ {+ key: "eventName",+ icon: Bolt,+ label: "Event name",+ hideInFilterDropdown: selectedTab === "clicks",+ options:+ eventNames?.map(({ eventName, ...rest }) => ({+ value: eventName,+ label: eventName,+ right: getFilterOptionTotal(rest),+ })) ?? null,+ },{key: "referer",icon: ReferredVia,@@ -895,6 +913,8 @@ export function useAnalyticsFilters({devices,browsers,os,+ eventNames,+ selectedTab,referers,refererUrls,baseUrls,diff --git a/packages/tinybird/pipes/v4_count.pipe b/packages/tinybird/pipes/v4_count.pipeindex e59db2a82f..9ac8830645 100644--- a/packages/tinybird/pipes/v4_count.pipe+++ b/packages/tinybird/pipes/v4_count.pipe@@ -261,6 +261,7 @@ SQL >{% if defined(device) %} AND device = {{ device }} {% end %}{% if defined(browser) %} AND browser = {{ browser }} {% end %}{% if defined(os) %} AND os = {{ os }} {% end %}+ {% if defined(eventName) %} AND event_name = {{ eventName }} {% end %}{% if defined(referer) %} AND referer = {{ referer }} {% end %}{% if defined(refererUrl) %} AND splitByString('?', referer_url)[1] = {{ refererUrl }} {% end %}{% if defined(utm_source) %}@@ -332,6 +333,10 @@ SQL >{% if operator == 'IN' %} AND trigger IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND trigger NOT IN {{ Array(values, 'String') }}{% end %}+ {% elif field == 'eventName' %}+ {% if operator == 'IN' %} AND event_name IN {{ Array(values, 'String') }}+ {% elif operator == 'NOT IN' %} AND event_name NOT IN {{ Array(values, 'String') }}+ {% end %}{% elif field == 'referer' %}{% if operator == 'IN' %} AND referer IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND referer NOT IN {{ Array(values, 'String') }}@@ -464,6 +469,7 @@ SQL >{% if defined(device) %} AND se.device = {{ device }} {% end %}{% if defined(browser) %} AND se.browser = {{ browser }} {% end %}{% if defined(os) %} AND se.os = {{ os }} {% end %}+ {% if defined(eventName) %} AND se.event_name = {{ eventName }} {% end %}{% if defined(referer) %} AND se.referer = {{ referer }} {% end %}{% if defined(refererUrl) %} AND splitByString('?', se.referer_url)[1] = {{ refererUrl }} {% end %}{% if defined(utm_source) %}@@ -535,6 +541,10 @@ SQL >{% if operator == 'IN' %} AND se.trigger IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND se.trigger NOT IN {{ Array(values, 'String') }}{% end %}+ {% elif field == 'eventName' %}+ {% if operator == 'IN' %} AND se.event_name IN {{ Array(values, 'String') }}+ {% elif operator == 'NOT IN' %} AND se.event_name NOT IN {{ Array(values, 'String') }}+ {% end %}{% elif field == 'referer' %}{% if operator == 'IN' %} AND se.referer IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND se.referer NOT IN {{ Array(values, 'String') }}diff --git a/packages/tinybird/pipes/v4_events.pipe b/packages/tinybird/pipes/v4_events.pipeindex a34901c121..3a05a7f1d1 100644--- a/packages/tinybird/pipes/v4_events.pipe+++ b/packages/tinybird/pipes/v4_events.pipe@@ -283,6 +283,7 @@ SQL >{% if defined(device) %} AND device = {{ device }} {% end %}{% if defined(browser) %} AND browser = {{ browser }} {% end %}{% if defined(os) %} AND os = {{ os }} {% end %}+ {% if defined(eventName) %} AND event_name = {{ eventName }} {% end %}{% if defined(referer) %} AND referer = {{ referer }} {% end %}{% if defined(refererUrl) %} AND splitByString('?', referer_url)[1] = {{ refererUrl }} {% end %}{% if defined(utm_source) %}@@ -354,6 +355,10 @@ SQL >{% if operator == 'IN' %} AND trigger IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND trigger NOT IN {{ Array(values, 'String') }}{% end %}+ {% elif field == 'eventName' %}+ {% if operator == 'IN' %} AND event_name IN {{ Array(values, 'String') }}+ {% elif operator == 'NOT IN' %} AND event_name NOT IN {{ Array(values, 'String') }}+ {% end %}{% elif field == 'referer' %}{% if operator == 'IN' %} AND referer IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND referer NOT IN {{ Array(values, 'String') }}@@ -482,6 +487,7 @@ SQL >{% if defined(device) %} AND se.device = {{ device }} {% end %}{% if defined(browser) %} AND se.browser = {{ browser }} {% end %}{% if defined(os) %} AND se.os = {{ os }} {% end %}+ {% if defined(eventName) %} AND se.event_name = {{ eventName }} {% end %}{% if defined(referer) %} AND se.referer = {{ referer }} {% end %}{% if defined(refererUrl) %}AND splitByString('?', se.referer_url)[1] = {{ refererUrl }}@@ -561,6 +567,10 @@ SQL >{% if operator == 'IN' %} AND se.trigger IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND se.trigger NOT IN {{ Array(values, 'String') }}{% end %}+ {% elif field == 'eventName' %}+ {% if operator == 'IN' %} AND se.event_name IN {{ Array(values, 'String') }}+ {% elif operator == 'NOT IN' %} AND se.event_name NOT IN {{ Array(values, 'String') }}+ {% end %}{% elif field == 'referer' %}{% if operator == 'IN' %} AND se.referer IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND se.referer NOT IN {{ Array(values, 'String') }}diff --git a/packages/tinybird/pipes/v4_group_by.pipe b/packages/tinybird/pipes/v4_group_by.pipeindex 3891c35800..25e4f07073 100644--- a/packages/tinybird/pipes/v4_group_by.pipe+++ b/packages/tinybird/pipes/v4_group_by.pipe@@ -118,6 +118,8 @@ SQL >os,{{ String(groupBy) }} = 'triggers',trigger,+ {{ String(groupBy) }} = 'event_names',+ '',link_id) AS groupByField,{% if String(groupBy) == 'cities' %} country, CONCAT(country, '-', region) as region,@@ -343,6 +345,8 @@ SQL >os,{{ String(groupBy) }} = 'triggers',trigger,+ {{ String(groupBy) }} = 'event_names',+ event_name,link_id) AS groupByField,{% if String(groupBy) == 'cities' %} country, CONCAT(country, '-', region) as region,@@ -375,6 +379,7 @@ SQL >{% if defined(device) %} AND device = {{ device }} {% end %}{% if defined(browser) %} AND browser = {{ browser }} {% end %}{% if defined(os) %} AND os = {{ os }} {% end %}+ {% if defined(eventName) %} AND event_name = {{ eventName }} {% end %}{% if defined(referer) %} AND referer = {{ referer }} {% end %}{% if defined(refererUrl) %} AND splitByString('?', referer_url)[1] = {{ refererUrl }} {% end %}{% if defined(utm_source) %}@@ -446,6 +451,10 @@ SQL >{% if operator == 'IN' %} AND trigger IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND trigger NOT IN {{ Array(values, 'String') }}{% end %}+ {% elif field == 'eventName' %}+ {% if operator == 'IN' %} AND event_name IN {{ Array(values, 'String') }}+ {% elif operator == 'NOT IN' %} AND event_name NOT IN {{ Array(values, 'String') }}+ {% end %}{% elif field == 'referer' %}{% if operator == 'IN' %} AND referer IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND referer NOT IN {{ Array(values, 'String') }}@@ -578,6 +587,8 @@ SQL >os,{{ String(groupBy) }} = 'triggers',trigger,+ {{ String(groupBy) }} = 'event_names',+ event_name,link_id) AS groupByField,{% if String(groupBy) == 'cities' %} country, CONCAT(country, '-', region) as region,@@ -626,6 +637,7 @@ SQL >{% if defined(device) %} AND se.device = {{ device }} {% end %}{% if defined(browser) %} AND se.browser = {{ browser }} {% end %}{% if defined(os) %} AND se.os = {{ os }} {% end %}+ {% if defined(eventName) %} AND se.event_name = {{ eventName }} {% end %}{% if defined(referer) %} AND se.referer = {{ referer }} {% end %}{% if defined(refererUrl) %} AND splitByString('?', se.referer_url)[1] = {{ refererUrl }} {% end %}{% if defined(utm_source) %}@@ -697,6 +709,10 @@ SQL >{% if operator == 'IN' %} AND se.trigger IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND se.trigger NOT IN {{ Array(values, 'String') }}{% end %}+ {% elif field == 'eventName' %}+ {% if operator == 'IN' %} AND se.event_name IN {{ Array(values, 'String') }}+ {% elif operator == 'NOT IN' %} AND se.event_name NOT IN {{ Array(values, 'String') }}+ {% end %}{% elif field == 'referer' %}{% if operator == 'IN' %} AND se.referer IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND se.referer NOT IN {{ Array(values, 'String') }}diff --git a/packages/tinybird/pipes/v4_group_by_link_metadata.pipe b/packages/tinybird/pipes/v4_group_by_link_metadata.pipeindex 0c2bcdea12..c5ecf5a091 100644--- a/packages/tinybird/pipes/v4_group_by_link_metadata.pipe+++ b/packages/tinybird/pipes/v4_group_by_link_metadata.pipe@@ -252,6 +252,7 @@ SQL >{% if defined(device) %} AND device = {{ device }} {% end %}{% if defined(browser) %} AND browser = {{ browser }} {% end %}{% if defined(os) %} AND os = {{ os }} {% end %}+ {% if defined(eventName) %} AND event_name = {{ eventName }} {% end %}{% if defined(referer) %} AND referer = {{ referer }} {% end %}{% if defined(refererUrl) %} AND splitByString('?', referer_url)[1] = {{ refererUrl }} {% end %}{% if defined(utm_source) %}@@ -306,6 +307,10 @@ SQL >{% if operator == 'IN' %} AND trigger IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND trigger NOT IN {{ Array(values, 'String') }}{% end %}+ {% elif field == 'eventName' %}+ {% if operator == 'IN' %} AND event_name IN {{ Array(values, 'String') }}+ {% elif operator == 'NOT IN' %} AND event_name NOT IN {{ Array(values, 'String') }}+ {% end %}{% elif field == 'referer' %}{% if operator == 'IN' %} AND referer IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND referer NOT IN {{ Array(values, 'String') }}@@ -439,6 +444,7 @@ SQL >{% if defined(device) %} AND se.device = {{ device }} {% end %}{% if defined(browser) %} AND se.browser = {{ browser }} {% end %}{% if defined(os) %} AND se.os = {{ os }} {% end %}+ {% if defined(eventName) %} AND se.event_name = {{ eventName }} {% end %}{% if defined(referer) %} AND se.referer = {{ referer }} {% end %}{% if defined(refererUrl) %} AND splitByString('?', se.referer_url)[1] = {{ refererUrl }} {% end %}{% if defined(utm_source) %}@@ -493,6 +499,10 @@ SQL >{% if operator == 'IN' %} AND se.trigger IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND se.trigger NOT IN {{ Array(values, 'String') }}{% end %}+ {% elif field == 'eventName' %}+ {% if operator == 'IN' %} AND se.event_name IN {{ Array(values, 'String') }}+ {% elif operator == 'NOT IN' %} AND se.event_name NOT IN {{ Array(values, 'String') }}+ {% end %}{% elif field == 'referer' %}{% if operator == 'IN' %} AND se.referer IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND se.referer NOT IN {{ Array(values, 'String') }}diff --git a/packages/tinybird/pipes/v4_timeseries.pipe b/packages/tinybird/pipes/v4_timeseries.pipeindex f9c3c9874b..573cd2b321 100644--- a/packages/tinybird/pipes/v4_timeseries.pipe+++ b/packages/tinybird/pipes/v4_timeseries.pipe@@ -346,6 +346,7 @@ SQL >{% if defined(device) %} AND device = {{ device }} {% end %}{% if defined(browser) %} AND browser = {{ browser }} {% end %}{% if defined(os) %} AND os = {{ os }} {% end %}+ {% if defined(eventName) %} AND event_name = {{ eventName }} {% end %}{% if defined(referer) %} AND referer = {{ referer }} {% end %}{% if defined(refererUrl) %} AND splitByString('?', referer_url)[1] = {{ refererUrl }} {% end %}{% if defined(utm_source) %}@@ -400,6 +401,10 @@ SQL >{% if operator == 'IN' %} AND trigger IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND trigger NOT IN {{ Array(values, 'String') }}{% end %}+ {% elif field == 'eventName' %}+ {% if operator == 'IN' %} AND event_name IN {{ Array(values, 'String') }}+ {% elif operator == 'NOT IN' %} AND event_name NOT IN {{ Array(values, 'String') }}+ {% end %}{% elif field == 'referer' %}{% if operator == 'IN' %} AND referer IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND referer NOT IN {{ Array(values, 'String') }}@@ -589,6 +594,7 @@ SQL >{% if defined(device) %} AND se.device = {{ device }} {% end %}{% if defined(browser) %} AND se.browser = {{ browser }} {% end %}{% if defined(os) %} AND se.os = {{ os }} {% end %}+ {% if defined(eventName) %} AND se.event_name = {{ eventName }} {% end %}{% if defined(referer) %} AND se.referer = {{ referer }} {% end %}{% if defined(refererUrl) %} AND splitByString('?', se.referer_url)[1] = {{ refererUrl }} {% end %}{% if defined(utm_source) %}@@ -643,6 +649,10 @@ SQL >{% if operator == 'IN' %} AND se.trigger IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND se.trigger NOT IN {{ Array(values, 'String') }}{% end %}+ {% elif field == 'eventName' %}+ {% if operator == 'IN' %} AND se.event_name IN {{ Array(values, 'String') }}+ {% elif operator == 'NOT IN' %} AND se.event_name NOT IN {{ Array(values, 'String') }}+ {% end %}{% elif field == 'referer' %}{% if operator == 'IN' %} AND se.referer IN {{ Array(values, 'String') }}{% elif operator == 'NOT IN' %} AND se.referer NOT IN {{ Array(values, 'String') }}