@adtrackify/at-tracking-event-types 3.1.30 → 3.1.32

package/dist/cjs/types/api/measures/definitions/tracked-measure-definitions.d.ts

@@ -0,0 +1,350 @@
+import { MEASURE } from '../measures';
+export declare const TRACKED_MEASURES_MAP: {
+    "tracked.page_views": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.view_contents": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.add_to_carts": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.initiate_checkouts": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.purchases": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.revenue": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.session_conversion_rate": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.revenue_per_visitor": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.revenue_per_session": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.sessions": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.visitors": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.add_to_cart_rate": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.view_content_rate": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.initiate_checkout_rate": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.atc_to_ic_rate": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.ic_to_purchase_rate": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.events_processed": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.avg_view_contents_per_session": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.avg_page_views_per_session": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.avg_sessions_per_visitor": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "site.ttfb": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "site.fcp": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "site.lcp": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "site.time_on_site": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.avg_page_visits_per_session": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.pv_to_vc_rate": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.vc_to_atc_rate": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+    };
+    "tracked.new_visitors": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+        in_development: boolean;
+    };
+    "tracked.new_visitors_percent": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+        in_development: boolean;
+    };
+    "tracked.new_session_percent": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+        in_development: boolean;
+    };
+    "tracked.new_sessions": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+        in_development: boolean;
+    };
+    "tracked.session_view_product_rate": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+        in_development: boolean;
+    };
+    "tracked.avg_time_on_page": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+        in_development: boolean;
+    };
+    "tracked.bounce_rate": {
+        title: string;
+        description: string;
+        sumPrefix: string;
+        sumSuffix: string;
+        avgPrefix: string;
+        avgSuffix: string;
+        icon: string;
+        measure: MEASURE;
+        in_development: boolean;
+    };
+};

package/dist/cjs/types/api/measures/definitions/tracked-measure-definitions.js

@@ -0,0 +1,354 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TRACKED_MEASURES_MAP = void 0;
+const measures_1 = require("../measures");
+exports.TRACKED_MEASURES_MAP = {
+    [measures_1.MEASURE.TRACKED_PAGE_VIEWS]: {
+        title: 'Page Views',
+        description: 'The total number of times a page was viewed.',
+        sumPrefix: '',
+        sumSuffix: '',
+        avgPrefix: '',
+        avgSuffix: '',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_PAGE_VIEWS,
+    },
+    [measures_1.MEASURE.TRACKED_VIEW_CONTENTS]: {
+        title: 'View Contents',
+        description: 'The total number of times a product page was viewed.',
+        sumPrefix: '',
+        sumSuffix: '',
+        avgPrefix: '',
+        avgSuffix: '',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_VIEW_CONTENTS,
+    },
+    [measures_1.MEASURE.TRACKED_ADD_TO_CARTS]: {
+        title: 'Add to Carts',
+        description: 'The total number of times a product was added to the cart.',
+        sumPrefix: '',
+        sumSuffix: '',
+        avgPrefix: '',
+        avgSuffix: '',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_ADD_TO_CARTS,
+    },
+    [measures_1.MEASURE.TRACKED_INITIATE_CHECKOUTS]: {
+        title: 'Initiate Checkouts',
+        description: 'The number of times a checkout was initiated.',
+        sumPrefix: '',
+        sumSuffix: '',
+        avgPrefix: '',
+        avgSuffix: '',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_INITIATE_CHECKOUTS,
+    },
+    [measures_1.MEASURE.TRACKED_PURCHASES]: {
+        title: 'Purchases',
+        description: 'The total number of tracked purchases.',
+        sumPrefix: '',
+        sumSuffix: '',
+        avgPrefix: '',
+        avgSuffix: '',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_PURCHASES,
+    },
+    [measures_1.MEASURE.TRACKED_REVENUE]: {
+        title: 'Revenue',
+        description: 'The total tracked revenue.',
+        sumPrefix: '$',
+        sumSuffix: '',
+        avgPrefix: '$',
+        avgSuffix: '',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_REVENUE,
+    },
+    [measures_1.MEASURE.TRACKED_SESSION_CONVERSION_RATE]: {
+        title: 'Session Conversion Rate',
+        description: 'The percentage of sessions that resulted in a conversion.',
+        sumPrefix: '',
+        sumSuffix: '%',
+        avgPrefix: '',
+        avgSuffix: '%',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_SESSION_CONVERSION_RATE,
+    },
+    [measures_1.MEASURE.TRACKED_REVENUE_PER_VISITOR]: {
+        title: 'Revenue per Visitor',
+        description: 'The average revenue generated per visitor.',
+        sumPrefix: '$',
+        sumSuffix: '',
+        avgPrefix: '$',
+        avgSuffix: '',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_REVENUE_PER_VISITOR,
+    },
+    [measures_1.MEASURE.TRACKED_REVENUE_PER_SESSION]: {
+        title: 'Revenue per Session',
+        description: 'The average revenue generated per session.',
+        sumPrefix: '$',
+        sumSuffix: '',
+        avgPrefix: '$',
+        avgSuffix: '',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_REVENUE_PER_SESSION,
+    },
+    [measures_1.MEASURE.TRACKED_UNIQUE_SESSIONS]: {
+        title: 'Unique Sessions',
+        description: 'The number of unique sessions.',
+        sumPrefix: '',
+        sumSuffix: '',
+        avgPrefix: '',
+        avgSuffix: '',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_UNIQUE_SESSIONS,
+    },
+    [measures_1.MEASURE.TRACKED_UNIQUE_VISITORS]: {
+        title: 'Unique Visitors',
+        description: 'The number of unique visitors.',
+        sumPrefix: '',
+        sumSuffix: '',
+        avgPrefix: '',
+        avgSuffix: '',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_UNIQUE_VISITORS,
+    },
+    [measures_1.MEASURE.TRACKED_ADD_TO_CART_RATE]: {
+        title: 'Add to Cart Rate',
+        description: 'The percentage of views that resulted in an add to cart.',
+        sumPrefix: '',
+        sumSuffix: '%',
+        avgPrefix: '',
+        avgSuffix: '%',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_ADD_TO_CART_RATE,
+    },
+    [measures_1.MEASURE.TRACKED_VIEW_CONTENT_RATE]: {
+        title: 'View Content Rate',
+        description: 'The percentage of page views that resulted in a view content.',
+        sumPrefix: '',
+        sumSuffix: '%',
+        avgPrefix: '',
+        avgSuffix: '%',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_VIEW_CONTENT_RATE,
+    },
+    [measures_1.MEASURE.TRACKED_INITIATE_CHECKOUT_RATE]: {
+        title: 'Initiate Checkout Rate',
+        description: 'The percentage of add to carts that resulted in an initiate checkout.',
+        sumPrefix: '',
+        sumSuffix: '%',
+        avgPrefix: '',
+        avgSuffix: '%',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_INITIATE_CHECKOUT_RATE,
+    },
+    [measures_1.MEASURE.TRACKED_ATC_TO_IC_RATE]: {
+        title: 'Add to Cart to Initiate Checkout Rate',
+        description: 'The percentage of add to carts that resulted in an initiate checkout.',
+        sumPrefix: '',
+        sumSuffix: '%',
+        avgPrefix: '',
+        avgSuffix: '%',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_ATC_TO_IC_RATE,
+    },
+    [measures_1.MEASURE.TRACKED_IC_TO_PURCHASE_RATE]: {
+        title: 'Initiate Checkout to Purchase Rate',
+        description: 'The percentage of initiate checkouts that resulted in a purchase.',
+        sumPrefix: '',
+        sumSuffix: '%',
+        avgPrefix: '',
+        avgSuffix: '%',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_IC_TO_PURCHASE_RATE,
+    },
+    [measures_1.MEASURE.TRACKED_TOTAL_EVENTS]: {
+        title: 'Total Events',
+        description: 'The total number of events processed.',
+        sumPrefix: '',
+        sumSuffix: '',
+        avgPrefix: '',
+        avgSuffix: '',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_TOTAL_EVENTS,
+    },
+    [measures_1.MEASURE.TRACKED_AVG_VIEW_CONTENTS_PER_SESSION]: {
+        title: 'Average View Contents per Session',
+        description: 'The average number of view contents per session.',
+        sumPrefix: '',
+        sumSuffix: '',
+        avgPrefix: '',
+        avgSuffix: '',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_AVG_VIEW_CONTENTS_PER_SESSION,
+    },
+    [measures_1.MEASURE.TRACKED_AVG_PAGE_VIEWS_PER_SESSION]: {
+        title: 'Average Page Views per Session',
+        description: 'The average number of page views per session.',
+        sumPrefix: '',
+        sumSuffix: '',
+        avgPrefix: '',
+        avgSuffix: '',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_AVG_PAGE_VIEWS_PER_SESSION,
+    },
+    [measures_1.MEASURE.TRACKED_AVG_SESSIONS_PER_VISITOR]: {
+        title: 'Avg. Sessions per Visitor',
+        description: 'The number of sessions per visitor.',
+        sumPrefix: '',
+        sumSuffix: '',
+        avgPrefix: '',
+        avgSuffix: '',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_AVG_SESSIONS_PER_VISITOR,
+    },
+    [measures_1.MEASURE.SITE_TTFB]: {
+        title: 'Time to First Byte',
+        description: 'The time it takes for the server to respond.',
+        sumPrefix: '',
+        sumSuffix: 'ms',
+        avgPrefix: '',
+        avgSuffix: 'ms',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.SITE_TTFB,
+    },
+    [measures_1.MEASURE.SITE_FCP]: {
+        title: 'First Contentful Paint',
+        description: 'The time it takes for the first content to appear.',
+        sumPrefix: '',
+        sumSuffix: 'ms',
+        avgPrefix: '',
+        avgSuffix: 'ms',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.SITE_FCP,
+    },
+    [measures_1.MEASURE.SITE_LCP]: {
+        title: 'Largest Contentful Paint',
+        description: 'The time it takes for the largest content to appear.',
+        sumPrefix: '',
+        sumSuffix: 'ms',
+        avgPrefix: '',
+        avgSuffix: 'ms',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.SITE_LCP,
+    },
+    [measures_1.MEASURE.SITE_TIME_ON_SITE]: {
+        title: 'Time on Site',
+        description: 'The average time spent on the site.',
+        sumPrefix: '',
+        sumSuffix: 's',
+        avgPrefix: '',
+        avgSuffix: 's',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.SITE_TIME_ON_SITE,
+    },
+    [measures_1.MEASURE.TRACKED_AVG_PAGE_VISITS_PER_SESSION]: {
+        title: 'Average Page Visits per Session',
+        description: 'The average number of page visits per session.',
+        sumPrefix: '',
+        sumSuffix: '',
+        avgPrefix: '',
+        avgSuffix: '',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_AVG_PAGE_VISITS_PER_SESSION,
+    },
+    [measures_1.MEASURE.TRACKED_PV_TO_VC_RATE]: {
+        title: 'Page Views to View Contents Rate',
+        description: 'The percentage of page views that resulted in a view content.',
+        sumPrefix: '',
+        sumSuffix: '%',
+        avgPrefix: '',
+        avgSuffix: '%',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_PV_TO_VC_RATE,
+    },
+    [measures_1.MEASURE.TRACKED_VC_TO_ATC_RATE]: {
+        title: 'View Contents to Add to Cart Rate',
+        description: 'The percentage of view contents that resulted in an add to cart.',
+        sumPrefix: '',
+        sumSuffix: '%',
+        avgPrefix: '',
+        avgSuffix: '%',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_VC_TO_ATC_RATE,
+    },
+    [measures_1.MEASURE.TRACKED_NEW_VISITORS]: {
+        title: 'New Visitors',
+        description: 'The number of new visitors.',
+        sumPrefix: '',
+        sumSuffix: '',
+        avgPrefix: '',
+        avgSuffix: '',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_NEW_VISITORS,
+        in_development: true,
+    },
+    [measures_1.MEASURE.TRACKED_NEW_VISITORS_PERCENT]: {
+        title: 'New Visitors Percentage',
+        description: 'The percentage of visitors that are new visitors.',
+        sumPrefix: '',
+        sumSuffix: '%',
+        avgPrefix: '',
+        avgSuffix: '%',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_NEW_VISITORS_PERCENT,
+        in_development: true,
+    },
+    [measures_1.MEASURE.TRACKED_NEW_SESSION_PERCENT]: {
+        title: 'New Session Percentage',
+        description: 'The percentage of sessions that are new sessions.',
+        sumPrefix: '',
+        sumSuffix: '%',
+        avgPrefix: '',
+        avgSuffix: '%',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_NEW_SESSION_PERCENT,
+        in_development: true,
+    },
+    [measures_1.MEASURE.TRACKED_NEW_SESSIONS]: {
+        title: 'New Sessions',
+        description: 'The number of new sessions.',
+        sumPrefix: '',
+        sumSuffix: '',
+        avgPrefix: '',
+        avgSuffix: '',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_NEW_SESSIONS,
+        in_development: true,
+    },
+    [measures_1.MEASURE.TRACKED_SESSION_VIEW_PRODUCT_RATE]: {
+        title: 'Session View Product Rate',
+        description: 'The percentage of sessions that view a product.',
+        sumPrefix: '',
+        sumSuffix: '%',
+        avgPrefix: '',
+        avgSuffix: '%',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_SESSION_VIEW_PRODUCT_RATE,
+        in_development: true,
+    },
+    [measures_1.MEASURE.TRACKED_AVG_TIME_ON_PAGE]: {
+        title: 'Average Time on Page',
+        description: 'The average time spent on a page.',
+        sumPrefix: '',
+        sumSuffix: 's',
+        avgPrefix: '',
+        avgSuffix: 's',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_AVG_TIME_ON_PAGE,
+        in_development: true,
+    },
+    [measures_1.MEASURE.TRACKED_BOUNCE_RATE]: {
+        title: 'Bounce Rate',
+        description: 'The percentage of sessions that bounce.',
+        sumPrefix: '',
+        sumSuffix: '%',
+        avgPrefix: '',
+        avgSuffix: '%',
+        icon: 'upstack',
+        measure: measures_1.MEASURE.TRACKED_BOUNCE_RATE,
+        in_development: true,
+    },
+};
+//# sourceMappingURL=tracked-measure-definitions.js.map