@adtrackify/at-tracking-event-types 2.0.66 → 2.0.68

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (127) hide show
  1. package/dist/cjs/index.d.ts +1 -1
  2. package/dist/cjs/index.js +17 -17
  3. package/dist/cjs/types/api/account.d.ts +36 -36
  4. package/dist/cjs/types/api/account.js +9 -9
  5. package/dist/cjs/types/api/destination-tracked-events.d.ts +11 -11
  6. package/dist/cjs/types/api/destination-tracked-events.js +3 -3
  7. package/dist/cjs/types/api/destinations/destination-catalog.d.ts +30 -30
  8. package/dist/cjs/types/api/destinations/destination-catalog.js +2 -2
  9. package/dist/cjs/types/api/destinations/destinations.d.ts +65 -65
  10. package/dist/cjs/types/api/destinations/destinations.js +26 -26
  11. package/dist/cjs/types/api/destinations/third-party-destination-configs.d.ts +53 -53
  12. package/dist/cjs/types/api/destinations/third-party-destination-configs.js +9 -9
  13. package/dist/cjs/types/api/event-status.d.ts +18 -18
  14. package/dist/cjs/types/api/event-status.js +9 -9
  15. package/dist/cjs/types/api/index.d.ts +13 -13
  16. package/dist/cjs/types/api/index.js +29 -29
  17. package/dist/cjs/types/api/log-events.d.ts +16 -16
  18. package/dist/cjs/types/api/log-events.js +2 -2
  19. package/dist/cjs/types/api/pixel-setup-health.d.ts +18 -18
  20. package/dist/cjs/types/api/pixel-setup-health.js +2 -2
  21. package/dist/cjs/types/api/query.d.ts +150 -150
  22. package/dist/cjs/types/api/query.js +100 -100
  23. package/dist/cjs/types/api/shopify-app-install.d.ts +47 -47
  24. package/dist/cjs/types/api/shopify-app-install.js +22 -22
  25. package/dist/cjs/types/api/subscription.d.ts +71 -71
  26. package/dist/cjs/types/api/subscription.js +31 -31
  27. package/dist/cjs/types/api/tracking-events.d.ts +11 -11
  28. package/dist/cjs/types/api/tracking-events.js +2 -2
  29. package/dist/cjs/types/api/user.d.ts +13 -13
  30. package/dist/cjs/types/api/user.js +2 -2
  31. package/dist/cjs/types/common/address.d.ts +15 -15
  32. package/dist/cjs/types/common/address.js +2 -2
  33. package/dist/cjs/types/common/currency.d.ts +1 -1
  34. package/dist/cjs/types/common/currency.js +63 -63
  35. package/dist/cjs/types/common/index.d.ts +2 -2
  36. package/dist/cjs/types/common/index.js +18 -18
  37. package/dist/cjs/types/event/base/event-name-enum.d.ts +48 -36
  38. package/dist/cjs/types/event/base/event-name-enum.js +54 -42
  39. package/dist/cjs/types/event/base/event-name-enum.js.map +1 -1
  40. package/dist/cjs/types/event/base/event.d.ts +20 -20
  41. package/dist/cjs/types/event/base/event.js +10 -10
  42. package/dist/cjs/types/event/base/index.d.ts +2 -2
  43. package/dist/cjs/types/event/base/index.js +18 -18
  44. package/dist/cjs/types/event/context/event-context-identity.d.ts +18 -18
  45. package/dist/cjs/types/event/context/event-context-identity.js +2 -2
  46. package/dist/cjs/types/event/context/event-context.d.ts +143 -143
  47. package/dist/cjs/types/event/context/event-context.js +2 -2
  48. package/dist/cjs/types/event/context/index.d.ts +2 -2
  49. package/dist/cjs/types/event/context/index.js +18 -18
  50. package/dist/cjs/types/event/index.d.ts +5 -5
  51. package/dist/cjs/types/event/index.js +21 -21
  52. package/dist/cjs/types/event/log-event.d.ts +35 -35
  53. package/dist/cjs/types/event/log-event.js +22 -22
  54. package/dist/cjs/types/event/metric-event.d.ts +13 -13
  55. package/dist/cjs/types/event/metric-event.js +2 -2
  56. package/dist/cjs/types/event/tracking-event.d.ts +62 -62
  57. package/dist/cjs/types/event/tracking-event.js +2 -2
  58. package/dist/cjs/types/event-bus-event.d.ts +25 -25
  59. package/dist/cjs/types/event-bus-event.js +2 -2
  60. package/dist/cjs/types/index.d.ts +5 -5
  61. package/dist/cjs/types/index.js +21 -21
  62. package/dist/cjs/types/third-party-event-configuration-types.d.ts +9 -9
  63. package/dist/cjs/types/third-party-event-configuration-types.js +2 -2
  64. package/dist/esm/index.d.ts +1 -1
  65. package/dist/esm/index.js +1 -1
  66. package/dist/esm/types/api/account.d.ts +36 -36
  67. package/dist/esm/types/api/account.js +6 -6
  68. package/dist/esm/types/api/destination-tracked-events.d.ts +11 -11
  69. package/dist/esm/types/api/destination-tracked-events.js +1 -1
  70. package/dist/esm/types/api/destinations/destination-catalog.d.ts +30 -30
  71. package/dist/esm/types/api/destinations/destination-catalog.js +1 -1
  72. package/dist/esm/types/api/destinations/destinations.d.ts +65 -65
  73. package/dist/esm/types/api/destinations/destinations.js +23 -23
  74. package/dist/esm/types/api/destinations/third-party-destination-configs.d.ts +53 -53
  75. package/dist/esm/types/api/destinations/third-party-destination-configs.js +6 -6
  76. package/dist/esm/types/api/event-status.d.ts +18 -18
  77. package/dist/esm/types/api/event-status.js +6 -6
  78. package/dist/esm/types/api/index.d.ts +13 -13
  79. package/dist/esm/types/api/index.js +13 -13
  80. package/dist/esm/types/api/log-events.d.ts +16 -16
  81. package/dist/esm/types/api/log-events.js +1 -1
  82. package/dist/esm/types/api/pixel-setup-health.d.ts +18 -18
  83. package/dist/esm/types/api/pixel-setup-health.js +1 -1
  84. package/dist/esm/types/api/query.d.ts +150 -150
  85. package/dist/esm/types/api/query.js +97 -97
  86. package/dist/esm/types/api/shopify-app-install.d.ts +47 -47
  87. package/dist/esm/types/api/shopify-app-install.js +19 -19
  88. package/dist/esm/types/api/subscription.d.ts +71 -71
  89. package/dist/esm/types/api/subscription.js +28 -28
  90. package/dist/esm/types/api/tracking-events.d.ts +11 -11
  91. package/dist/esm/types/api/tracking-events.js +1 -1
  92. package/dist/esm/types/api/user.d.ts +13 -13
  93. package/dist/esm/types/api/user.js +1 -1
  94. package/dist/esm/types/common/address.d.ts +15 -15
  95. package/dist/esm/types/common/address.js +1 -1
  96. package/dist/esm/types/common/currency.d.ts +1 -1
  97. package/dist/esm/types/common/currency.js +60 -60
  98. package/dist/esm/types/common/index.d.ts +2 -2
  99. package/dist/esm/types/common/index.js +2 -2
  100. package/dist/esm/types/event/base/event-name-enum.d.ts +48 -36
  101. package/dist/esm/types/event/base/event-name-enum.js +51 -39
  102. package/dist/esm/types/event/base/event-name-enum.js.map +1 -1
  103. package/dist/esm/types/event/base/event.d.ts +20 -20
  104. package/dist/esm/types/event/base/event.js +7 -7
  105. package/dist/esm/types/event/base/index.d.ts +2 -2
  106. package/dist/esm/types/event/base/index.js +2 -2
  107. package/dist/esm/types/event/context/event-context-identity.d.ts +18 -18
  108. package/dist/esm/types/event/context/event-context-identity.js +1 -1
  109. package/dist/esm/types/event/context/event-context.d.ts +143 -143
  110. package/dist/esm/types/event/context/event-context.js +1 -1
  111. package/dist/esm/types/event/context/index.d.ts +2 -2
  112. package/dist/esm/types/event/context/index.js +2 -2
  113. package/dist/esm/types/event/index.d.ts +5 -5
  114. package/dist/esm/types/event/index.js +5 -5
  115. package/dist/esm/types/event/log-event.d.ts +35 -35
  116. package/dist/esm/types/event/log-event.js +19 -19
  117. package/dist/esm/types/event/metric-event.d.ts +13 -13
  118. package/dist/esm/types/event/metric-event.js +1 -1
  119. package/dist/esm/types/event/tracking-event.d.ts +62 -62
  120. package/dist/esm/types/event/tracking-event.js +1 -1
  121. package/dist/esm/types/event-bus-event.d.ts +25 -25
  122. package/dist/esm/types/event-bus-event.js +1 -1
  123. package/dist/esm/types/index.d.ts +5 -5
  124. package/dist/esm/types/index.js +5 -5
  125. package/dist/esm/types/third-party-event-configuration-types.d.ts +9 -9
  126. package/dist/esm/types/third-party-event-configuration-types.js +1 -1
  127. package/package.json +1 -1
@@ -1,30 +1,30 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./account"), exports);
18
- __exportStar(require("./destinations/destinations"), exports);
19
- __exportStar(require("./destinations/destination-catalog"), exports);
20
- __exportStar(require("./destinations/third-party-destination-configs"), exports);
21
- __exportStar(require("./shopify-app-install"), exports);
22
- __exportStar(require("./subscription"), exports);
23
- __exportStar(require("./user"), exports);
24
- __exportStar(require("./query"), exports);
25
- __exportStar(require("./event-status"), exports);
26
- __exportStar(require("./log-events"), exports);
27
- __exportStar(require("./tracking-events"), exports);
28
- __exportStar(require("./destination-tracked-events"), exports);
29
- __exportStar(require("./pixel-setup-health"), exports);
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./account"), exports);
18
+ __exportStar(require("./destinations/destinations"), exports);
19
+ __exportStar(require("./destinations/destination-catalog"), exports);
20
+ __exportStar(require("./destinations/third-party-destination-configs"), exports);
21
+ __exportStar(require("./shopify-app-install"), exports);
22
+ __exportStar(require("./subscription"), exports);
23
+ __exportStar(require("./user"), exports);
24
+ __exportStar(require("./query"), exports);
25
+ __exportStar(require("./event-status"), exports);
26
+ __exportStar(require("./log-events"), exports);
27
+ __exportStar(require("./tracking-events"), exports);
28
+ __exportStar(require("./destination-tracked-events"), exports);
29
+ __exportStar(require("./pixel-setup-health"), exports);
30
30
  //# sourceMappingURL=index.js.map
@@ -1,16 +1,16 @@
1
- import { LogEvent, LogLevel } from '../event';
2
- export interface LogEventRecord {
3
- eventId: string;
4
- pixelId_logLevel: string;
5
- eventName: string;
6
- pixelId: string;
7
- destinationId?: string;
8
- source: string;
9
- service: string;
10
- logLevel: LogLevel;
11
- logMessage: string;
12
- logEvent: LogEvent;
13
- logGroup: string;
14
- collectedAt?: string;
15
- expiredAt: number;
16
- }
1
+ import { LogEvent, LogLevel } from '../event';
2
+ export interface LogEventRecord {
3
+ eventId: string;
4
+ pixelId_logLevel: string;
5
+ eventName: string;
6
+ pixelId: string;
7
+ destinationId?: string;
8
+ source: string;
9
+ service: string;
10
+ logLevel: LogLevel;
11
+ logMessage: string;
12
+ logEvent: LogEvent;
13
+ logGroup: string;
14
+ collectedAt?: string;
15
+ expiredAt: number;
16
+ }
@@ -1,3 +1,3 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  //# sourceMappingURL=log-events.js.map
@@ -1,18 +1,18 @@
1
- export interface PixelSetupHealth {
2
- accountId: string;
3
- healthAttributes: HealthAttributes;
4
- }
5
- export interface HealthAttributes {
6
- noOfDestinations: number;
7
- noOfEnabledDestinations: number;
8
- destinations: DestinationHealth[];
9
- destinationsHealthy: boolean;
10
- themeAppExtensionHealthy: boolean;
11
- conversionPixelHealthy: boolean;
12
- }
13
- export interface DestinationHealth {
14
- id: string;
15
- displayName: string;
16
- healthy: boolean;
17
- enabled: boolean;
18
- }
1
+ export interface PixelSetupHealth {
2
+ accountId: string;
3
+ healthAttributes: HealthAttributes;
4
+ }
5
+ export interface HealthAttributes {
6
+ noOfDestinations: number;
7
+ noOfEnabledDestinations: number;
8
+ destinations: DestinationHealth[];
9
+ destinationsHealthy: boolean;
10
+ themeAppExtensionHealthy: boolean;
11
+ conversionPixelHealthy: boolean;
12
+ }
13
+ export interface DestinationHealth {
14
+ id: string;
15
+ displayName: string;
16
+ healthy: boolean;
17
+ enabled: boolean;
18
+ }
@@ -1,3 +1,3 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  //# sourceMappingURL=pixel-setup-health.js.map
@@ -1,150 +1,150 @@
1
- export interface DateRange {
2
- start: string;
3
- end: string;
4
- }
5
- export declare enum GRANULARITY {
6
- NONE = "none",
7
- SECOND = "second",
8
- MINUTE = "minute",
9
- HOUR = "hour",
10
- DAY = "day",
11
- WEEK = "week",
12
- MONTH = "month",
13
- QUARTER = "quarter",
14
- YEAR = "year"
15
- }
16
- export declare enum MEASURE {
17
- TRACKED_PAGE_VIEWS = "tracked.page_views",
18
- TRACKED_VIEW_CONTENTS = "tracked.view_contents",
19
- TRACKED_ADD_TO_CARTS = "tracked.add_to_carts",
20
- TRACKED_INITIATE_CHECKOUTS = "tracked.initiate_checkouts",
21
- TRACKED_PURCHASES = "tracked.purchases",
22
- TRACKED_REVENUE = "tracked.revenue",
23
- TRACKED_SESSION_CONVERSION_RATE = "tracked.session_conversion_rate",
24
- TRACKED_REVENUE_PER_VISITOR = "tracked.revenue_per_visitor",
25
- TRACKED_REVENUE_PER_SESSION = "tracked.revenue_per_session",
26
- TRACKED_UNIQUE_SESSIONS = "tracked.sessions",
27
- TRACKED_UNIQUE_VISITORS = "tracked.visitors",
28
- TRACKED_ADD_TO_CART_RATE = "tracked.add_to_cart_rate",
29
- TRACKED_VIEW_CONTENT_RATE = "tracked.view_content_rate",
30
- TRACKED_INITIATE_CHECKOUT_RATE = "tracked.initiate_checkout_rate",
31
- TRACKED_ATC_TO_IC_RATE = "tracked.atc_to_ic_rate",
32
- TRACKED_IC_TO_PURCHASE_RATE = "tracked.ic_to_purchase_rate",
33
- TRACKED_TOTAL_EVENTS = "tracked.events_processed",
34
- SHOPIFY_CUSTOMERS = "shopify.customers",
35
- SHOPIFY_ABANDONED_CHECKOUTS_VALUE = "shopify.abandoned_checkouts_value",
36
- SHOPIFY_ABANDONED_CHECKOUTS = "shopify.abandoned_checkouts",
37
- SHOPIFY_REFUNDS = "shopify.refunds_count",
38
- SHOPIFY_REFUND_REVENUE = "shopify.refunds_amount",
39
- SHOPIFY_REFUND_RATE = "shopify.refunds_rate",
40
- SHOPIFY_DISCOUNTS = "shopify.discounts_count",
41
- SHOPIFY_DISCOUNT_AMOUNT = "shopify.discount_amount",
42
- SHOPIFY_DISCOUNT_RATE = "shopify.discounts_rate",
43
- SHOPIFY_ORDERS = "shopify.order_count",
44
- SHOPIFY_REVENUE = "shopify.revenue",
45
- SHOPIFY_AOV = "shopify.average_order_value",
46
- SHOPIFY_TOP_PRODUCTS = "shopify.top_products",
47
- SHOPIFY_CUSTOMER_LTV = "shopify.customer_ltv",
48
- SHOPIFY_REPEAT_CUSTOMER_RATE = "shopify.repeat_customer_rate",
49
- SHOPIFY_TAX_AMOUNT = "shopify.tax_amount",
50
- SHOPIFY_SHIPPING_AMOUNT = "shopify.shipping_amount",
51
- SHOPIFY_SUBTOTAL_AMOUNT = "shopify.subtotal_amount",
52
- SHOPIFY_NEW_CUSTOMER_RATE = "shopify.new_customer_rate",
53
- SHOPIFY_RETURNING_CUSTOMER_RATE = "shopify.new_customer_rate",
54
- SITE_TTFB = "site.ttfb",
55
- SITE_FCP = "site.fcp",
56
- SITE_LCP = "site.lcp",
57
- SITE_TIME_ON_SITE = "site.time_on_site"
58
- }
59
- export interface Query {
60
- pixelId: string;
61
- measures: MEASURE[];
62
- dateRange: DateRange;
63
- compareDateRange?: DateRange;
64
- granularity?: GRANULARITY;
65
- dimensions?: DIMENSION[];
66
- filters?: any[];
67
- timezone?: string;
68
- orderSettings?: OrderSettings;
69
- }
70
- export interface OrderSettings {
71
- countVoidedOrders?: boolean;
72
- countPendingOrders?: boolean;
73
- }
74
- export interface AppliedDimensions {
75
- dimensionName?: string;
76
- dimensionValue?: string;
77
- }
78
- export declare type MeasureDataRow = {
79
- [key: string]: any;
80
- dt?: string;
81
- start?: string;
82
- end?: string;
83
- };
84
- export interface QueryData {
85
- primary?: MeasureDataRow[];
86
- compare?: MeasureDataRow[];
87
- }
88
- export interface MeasureDetail {
89
- measure: MEASURE;
90
- isAverage: boolean;
91
- isPercentage: boolean;
92
- calculatedAverage: boolean;
93
- success: boolean;
94
- primaryAvg: number;
95
- compareAvg: number;
96
- primarySum: number;
97
- compareSum: number;
98
- percentDiff: number;
99
- }
100
- export interface QueryResult {
101
- granularity: GRANULARITY;
102
- dimensions: DIMENSION[];
103
- dateRange: DateRange;
104
- compareDateRange?: DateRange;
105
- measureDetails: MeasureDetail[] | null;
106
- data: QueryData | null;
107
- }
108
- export interface QueryResponse {
109
- results: QueryResult[];
110
- }
111
- export declare enum DIMENSION {
112
- DEVICE_MODEL = "device_model",
113
- DEVICE_VENDOR = "device_vendor",
114
- DEVICE_TYPE = "device_type",
115
- BROWSER = "browser",
116
- BROWSER_VERSION = "browser_version",
117
- BROWSER_OS = "browser_os",
118
- OS = "OS",
119
- LANDING_PATH = "landing_path",
120
- PAGE_PATH = "path",
121
- PAGE_TITLE = "title",
122
- QUERY_STRING = "query",
123
- GATEWAY = "gateway",
124
- CURRENCY = "currency",
125
- SHIPPING_CODE = "shipping_code",
126
- IS_MOBILE = "is_mobile",
127
- IS_WIRELESS = "is_wireless",
128
- CITY = "city",
129
- PROVINCE_CODE = "province_code",
130
- PROVINCE = "province",
131
- COUNTRY_CODE = "country_code",
132
- COUNTRY = "country",
133
- POSTAL_CODE = "postal_code",
134
- FINANCIAL_STATUS = "financial_status",
135
- FULFILLMENT_STATUS = "fulfillment_status",
136
- DISCOUNT_CODE = "discount_code",
137
- REFERRER = "referrer",
138
- REFERRER_MEDIUM = "referrer_medium",
139
- REFERRER_SOURCE = "referrer_source",
140
- REFERRER_TERM = "referrer_term",
141
- UTM_CAMPAIGN = "utm_campaign",
142
- UTM_SOURCE = "utm_source",
143
- UTM_MEDIUM = "utm_medium",
144
- UTM_TERM = "utm_term",
145
- UTM_CONTENT = "utm_content",
146
- CLICK_NETWORK = "click_network",
147
- ADBLOCK_DETECTED = "adblock_detected",
148
- TIMEZONE = "timezone",
149
- LOCALE = "locale"
150
- }
1
+ export interface DateRange {
2
+ start: string;
3
+ end: string;
4
+ }
5
+ export declare enum GRANULARITY {
6
+ NONE = "none",
7
+ SECOND = "second",
8
+ MINUTE = "minute",
9
+ HOUR = "hour",
10
+ DAY = "day",
11
+ WEEK = "week",
12
+ MONTH = "month",
13
+ QUARTER = "quarter",
14
+ YEAR = "year"
15
+ }
16
+ export declare enum MEASURE {
17
+ TRACKED_PAGE_VIEWS = "tracked.page_views",
18
+ TRACKED_VIEW_CONTENTS = "tracked.view_contents",
19
+ TRACKED_ADD_TO_CARTS = "tracked.add_to_carts",
20
+ TRACKED_INITIATE_CHECKOUTS = "tracked.initiate_checkouts",
21
+ TRACKED_PURCHASES = "tracked.purchases",
22
+ TRACKED_REVENUE = "tracked.revenue",
23
+ TRACKED_SESSION_CONVERSION_RATE = "tracked.session_conversion_rate",
24
+ TRACKED_REVENUE_PER_VISITOR = "tracked.revenue_per_visitor",
25
+ TRACKED_REVENUE_PER_SESSION = "tracked.revenue_per_session",
26
+ TRACKED_UNIQUE_SESSIONS = "tracked.sessions",
27
+ TRACKED_UNIQUE_VISITORS = "tracked.visitors",
28
+ TRACKED_ADD_TO_CART_RATE = "tracked.add_to_cart_rate",
29
+ TRACKED_VIEW_CONTENT_RATE = "tracked.view_content_rate",
30
+ TRACKED_INITIATE_CHECKOUT_RATE = "tracked.initiate_checkout_rate",
31
+ TRACKED_ATC_TO_IC_RATE = "tracked.atc_to_ic_rate",
32
+ TRACKED_IC_TO_PURCHASE_RATE = "tracked.ic_to_purchase_rate",
33
+ TRACKED_TOTAL_EVENTS = "tracked.events_processed",
34
+ SHOPIFY_CUSTOMERS = "shopify.customers",
35
+ SHOPIFY_ABANDONED_CHECKOUTS_VALUE = "shopify.abandoned_checkouts_value",
36
+ SHOPIFY_ABANDONED_CHECKOUTS = "shopify.abandoned_checkouts",
37
+ SHOPIFY_REFUNDS = "shopify.refunds_count",
38
+ SHOPIFY_REFUND_REVENUE = "shopify.refunds_amount",
39
+ SHOPIFY_REFUND_RATE = "shopify.refunds_rate",
40
+ SHOPIFY_DISCOUNTS = "shopify.discounts_count",
41
+ SHOPIFY_DISCOUNT_AMOUNT = "shopify.discount_amount",
42
+ SHOPIFY_DISCOUNT_RATE = "shopify.discounts_rate",
43
+ SHOPIFY_ORDERS = "shopify.order_count",
44
+ SHOPIFY_REVENUE = "shopify.revenue",
45
+ SHOPIFY_AOV = "shopify.average_order_value",
46
+ SHOPIFY_TOP_PRODUCTS = "shopify.top_products",
47
+ SHOPIFY_CUSTOMER_LTV = "shopify.customer_ltv",
48
+ SHOPIFY_REPEAT_CUSTOMER_RATE = "shopify.repeat_customer_rate",
49
+ SHOPIFY_TAX_AMOUNT = "shopify.tax_amount",
50
+ SHOPIFY_SHIPPING_AMOUNT = "shopify.shipping_amount",
51
+ SHOPIFY_SUBTOTAL_AMOUNT = "shopify.subtotal_amount",
52
+ SHOPIFY_NEW_CUSTOMER_RATE = "shopify.new_customer_rate",
53
+ SHOPIFY_RETURNING_CUSTOMER_RATE = "shopify.new_customer_rate",
54
+ SITE_TTFB = "site.ttfb",
55
+ SITE_FCP = "site.fcp",
56
+ SITE_LCP = "site.lcp",
57
+ SITE_TIME_ON_SITE = "site.time_on_site"
58
+ }
59
+ export interface Query {
60
+ pixelId: string;
61
+ measures: MEASURE[];
62
+ dateRange: DateRange;
63
+ compareDateRange?: DateRange;
64
+ granularity?: GRANULARITY;
65
+ dimensions?: DIMENSION[];
66
+ filters?: any[];
67
+ timezone?: string;
68
+ orderSettings?: OrderSettings;
69
+ }
70
+ export interface OrderSettings {
71
+ countVoidedOrders?: boolean;
72
+ countPendingOrders?: boolean;
73
+ }
74
+ export interface AppliedDimensions {
75
+ dimensionName?: string;
76
+ dimensionValue?: string;
77
+ }
78
+ export declare type MeasureDataRow = {
79
+ [key: string]: any;
80
+ dt?: string;
81
+ start?: string;
82
+ end?: string;
83
+ };
84
+ export interface QueryData {
85
+ primary?: MeasureDataRow[];
86
+ compare?: MeasureDataRow[];
87
+ }
88
+ export interface MeasureDetail {
89
+ measure: MEASURE;
90
+ isAverage: boolean;
91
+ isPercentage: boolean;
92
+ calculatedAverage: boolean;
93
+ success: boolean;
94
+ primaryAvg: number;
95
+ compareAvg: number;
96
+ primarySum: number;
97
+ compareSum: number;
98
+ percentDiff: number;
99
+ }
100
+ export interface QueryResult {
101
+ granularity: GRANULARITY;
102
+ dimensions: DIMENSION[];
103
+ dateRange: DateRange;
104
+ compareDateRange?: DateRange;
105
+ measureDetails: MeasureDetail[] | null;
106
+ data: QueryData | null;
107
+ }
108
+ export interface QueryResponse {
109
+ results: QueryResult[];
110
+ }
111
+ export declare enum DIMENSION {
112
+ DEVICE_MODEL = "device_model",
113
+ DEVICE_VENDOR = "device_vendor",
114
+ DEVICE_TYPE = "device_type",
115
+ BROWSER = "browser",
116
+ BROWSER_VERSION = "browser_version",
117
+ BROWSER_OS = "browser_os",
118
+ OS = "OS",
119
+ LANDING_PATH = "landing_path",
120
+ PAGE_PATH = "path",
121
+ PAGE_TITLE = "title",
122
+ QUERY_STRING = "query",
123
+ GATEWAY = "gateway",
124
+ CURRENCY = "currency",
125
+ SHIPPING_CODE = "shipping_code",
126
+ IS_MOBILE = "is_mobile",
127
+ IS_WIRELESS = "is_wireless",
128
+ CITY = "city",
129
+ PROVINCE_CODE = "province_code",
130
+ PROVINCE = "province",
131
+ COUNTRY_CODE = "country_code",
132
+ COUNTRY = "country",
133
+ POSTAL_CODE = "postal_code",
134
+ FINANCIAL_STATUS = "financial_status",
135
+ FULFILLMENT_STATUS = "fulfillment_status",
136
+ DISCOUNT_CODE = "discount_code",
137
+ REFERRER = "referrer",
138
+ REFERRER_MEDIUM = "referrer_medium",
139
+ REFERRER_SOURCE = "referrer_source",
140
+ REFERRER_TERM = "referrer_term",
141
+ UTM_CAMPAIGN = "utm_campaign",
142
+ UTM_SOURCE = "utm_source",
143
+ UTM_MEDIUM = "utm_medium",
144
+ UTM_TERM = "utm_term",
145
+ UTM_CONTENT = "utm_content",
146
+ CLICK_NETWORK = "click_network",
147
+ ADBLOCK_DETECTED = "adblock_detected",
148
+ TIMEZONE = "timezone",
149
+ LOCALE = "locale"
150
+ }
@@ -1,101 +1,101 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.DIMENSION = exports.MEASURE = exports.GRANULARITY = void 0;
4
- var GRANULARITY;
5
- (function (GRANULARITY) {
6
- GRANULARITY["NONE"] = "none";
7
- GRANULARITY["SECOND"] = "second";
8
- GRANULARITY["MINUTE"] = "minute";
9
- GRANULARITY["HOUR"] = "hour";
10
- GRANULARITY["DAY"] = "day";
11
- GRANULARITY["WEEK"] = "week";
12
- GRANULARITY["MONTH"] = "month";
13
- GRANULARITY["QUARTER"] = "quarter";
14
- GRANULARITY["YEAR"] = "year";
15
- })(GRANULARITY = exports.GRANULARITY || (exports.GRANULARITY = {}));
16
- var MEASURE;
17
- (function (MEASURE) {
18
- MEASURE["TRACKED_PAGE_VIEWS"] = "tracked.page_views";
19
- MEASURE["TRACKED_VIEW_CONTENTS"] = "tracked.view_contents";
20
- MEASURE["TRACKED_ADD_TO_CARTS"] = "tracked.add_to_carts";
21
- MEASURE["TRACKED_INITIATE_CHECKOUTS"] = "tracked.initiate_checkouts";
22
- MEASURE["TRACKED_PURCHASES"] = "tracked.purchases";
23
- MEASURE["TRACKED_REVENUE"] = "tracked.revenue";
24
- MEASURE["TRACKED_SESSION_CONVERSION_RATE"] = "tracked.session_conversion_rate";
25
- MEASURE["TRACKED_REVENUE_PER_VISITOR"] = "tracked.revenue_per_visitor";
26
- MEASURE["TRACKED_REVENUE_PER_SESSION"] = "tracked.revenue_per_session";
27
- MEASURE["TRACKED_UNIQUE_SESSIONS"] = "tracked.sessions";
28
- MEASURE["TRACKED_UNIQUE_VISITORS"] = "tracked.visitors";
29
- MEASURE["TRACKED_ADD_TO_CART_RATE"] = "tracked.add_to_cart_rate";
30
- MEASURE["TRACKED_VIEW_CONTENT_RATE"] = "tracked.view_content_rate";
31
- MEASURE["TRACKED_INITIATE_CHECKOUT_RATE"] = "tracked.initiate_checkout_rate";
32
- MEASURE["TRACKED_ATC_TO_IC_RATE"] = "tracked.atc_to_ic_rate";
33
- MEASURE["TRACKED_IC_TO_PURCHASE_RATE"] = "tracked.ic_to_purchase_rate";
34
- MEASURE["TRACKED_TOTAL_EVENTS"] = "tracked.events_processed";
35
- MEASURE["SHOPIFY_CUSTOMERS"] = "shopify.customers";
36
- MEASURE["SHOPIFY_ABANDONED_CHECKOUTS_VALUE"] = "shopify.abandoned_checkouts_value";
37
- MEASURE["SHOPIFY_ABANDONED_CHECKOUTS"] = "shopify.abandoned_checkouts";
38
- MEASURE["SHOPIFY_REFUNDS"] = "shopify.refunds_count";
39
- MEASURE["SHOPIFY_REFUND_REVENUE"] = "shopify.refunds_amount";
40
- MEASURE["SHOPIFY_REFUND_RATE"] = "shopify.refunds_rate";
41
- MEASURE["SHOPIFY_DISCOUNTS"] = "shopify.discounts_count";
42
- MEASURE["SHOPIFY_DISCOUNT_AMOUNT"] = "shopify.discount_amount";
43
- MEASURE["SHOPIFY_DISCOUNT_RATE"] = "shopify.discounts_rate";
44
- MEASURE["SHOPIFY_ORDERS"] = "shopify.order_count";
45
- MEASURE["SHOPIFY_REVENUE"] = "shopify.revenue";
46
- MEASURE["SHOPIFY_AOV"] = "shopify.average_order_value";
47
- MEASURE["SHOPIFY_TOP_PRODUCTS"] = "shopify.top_products";
48
- MEASURE["SHOPIFY_CUSTOMER_LTV"] = "shopify.customer_ltv";
49
- MEASURE["SHOPIFY_REPEAT_CUSTOMER_RATE"] = "shopify.repeat_customer_rate";
50
- MEASURE["SHOPIFY_TAX_AMOUNT"] = "shopify.tax_amount";
51
- MEASURE["SHOPIFY_SHIPPING_AMOUNT"] = "shopify.shipping_amount";
52
- MEASURE["SHOPIFY_SUBTOTAL_AMOUNT"] = "shopify.subtotal_amount";
53
- MEASURE["SHOPIFY_NEW_CUSTOMER_RATE"] = "shopify.new_customer_rate";
54
- MEASURE["SHOPIFY_RETURNING_CUSTOMER_RATE"] = "shopify.new_customer_rate";
55
- MEASURE["SITE_TTFB"] = "site.ttfb";
56
- MEASURE["SITE_FCP"] = "site.fcp";
57
- MEASURE["SITE_LCP"] = "site.lcp";
58
- MEASURE["SITE_TIME_ON_SITE"] = "site.time_on_site";
59
- })(MEASURE = exports.MEASURE || (exports.MEASURE = {}));
60
- var DIMENSION;
61
- (function (DIMENSION) {
62
- DIMENSION["DEVICE_MODEL"] = "device_model";
63
- DIMENSION["DEVICE_VENDOR"] = "device_vendor";
64
- DIMENSION["DEVICE_TYPE"] = "device_type";
65
- DIMENSION["BROWSER"] = "browser";
66
- DIMENSION["BROWSER_VERSION"] = "browser_version";
67
- DIMENSION["BROWSER_OS"] = "browser_os";
68
- DIMENSION["OS"] = "OS";
69
- DIMENSION["LANDING_PATH"] = "landing_path";
70
- DIMENSION["PAGE_PATH"] = "path";
71
- DIMENSION["PAGE_TITLE"] = "title";
72
- DIMENSION["QUERY_STRING"] = "query";
73
- DIMENSION["GATEWAY"] = "gateway";
74
- DIMENSION["CURRENCY"] = "currency";
75
- DIMENSION["SHIPPING_CODE"] = "shipping_code";
76
- DIMENSION["IS_MOBILE"] = "is_mobile";
77
- DIMENSION["IS_WIRELESS"] = "is_wireless";
78
- DIMENSION["CITY"] = "city";
79
- DIMENSION["PROVINCE_CODE"] = "province_code";
80
- DIMENSION["PROVINCE"] = "province";
81
- DIMENSION["COUNTRY_CODE"] = "country_code";
82
- DIMENSION["COUNTRY"] = "country";
83
- DIMENSION["POSTAL_CODE"] = "postal_code";
84
- DIMENSION["FINANCIAL_STATUS"] = "financial_status";
85
- DIMENSION["FULFILLMENT_STATUS"] = "fulfillment_status";
86
- DIMENSION["DISCOUNT_CODE"] = "discount_code";
87
- DIMENSION["REFERRER"] = "referrer";
88
- DIMENSION["REFERRER_MEDIUM"] = "referrer_medium";
89
- DIMENSION["REFERRER_SOURCE"] = "referrer_source";
90
- DIMENSION["REFERRER_TERM"] = "referrer_term";
91
- DIMENSION["UTM_CAMPAIGN"] = "utm_campaign";
92
- DIMENSION["UTM_SOURCE"] = "utm_source";
93
- DIMENSION["UTM_MEDIUM"] = "utm_medium";
94
- DIMENSION["UTM_TERM"] = "utm_term";
95
- DIMENSION["UTM_CONTENT"] = "utm_content";
96
- DIMENSION["CLICK_NETWORK"] = "click_network";
97
- DIMENSION["ADBLOCK_DETECTED"] = "adblock_detected";
98
- DIMENSION["TIMEZONE"] = "timezone";
99
- DIMENSION["LOCALE"] = "locale";
100
- })(DIMENSION = exports.DIMENSION || (exports.DIMENSION = {}));
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DIMENSION = exports.MEASURE = exports.GRANULARITY = void 0;
4
+ var GRANULARITY;
5
+ (function (GRANULARITY) {
6
+ GRANULARITY["NONE"] = "none";
7
+ GRANULARITY["SECOND"] = "second";
8
+ GRANULARITY["MINUTE"] = "minute";
9
+ GRANULARITY["HOUR"] = "hour";
10
+ GRANULARITY["DAY"] = "day";
11
+ GRANULARITY["WEEK"] = "week";
12
+ GRANULARITY["MONTH"] = "month";
13
+ GRANULARITY["QUARTER"] = "quarter";
14
+ GRANULARITY["YEAR"] = "year";
15
+ })(GRANULARITY = exports.GRANULARITY || (exports.GRANULARITY = {}));
16
+ var MEASURE;
17
+ (function (MEASURE) {
18
+ MEASURE["TRACKED_PAGE_VIEWS"] = "tracked.page_views";
19
+ MEASURE["TRACKED_VIEW_CONTENTS"] = "tracked.view_contents";
20
+ MEASURE["TRACKED_ADD_TO_CARTS"] = "tracked.add_to_carts";
21
+ MEASURE["TRACKED_INITIATE_CHECKOUTS"] = "tracked.initiate_checkouts";
22
+ MEASURE["TRACKED_PURCHASES"] = "tracked.purchases";
23
+ MEASURE["TRACKED_REVENUE"] = "tracked.revenue";
24
+ MEASURE["TRACKED_SESSION_CONVERSION_RATE"] = "tracked.session_conversion_rate";
25
+ MEASURE["TRACKED_REVENUE_PER_VISITOR"] = "tracked.revenue_per_visitor";
26
+ MEASURE["TRACKED_REVENUE_PER_SESSION"] = "tracked.revenue_per_session";
27
+ MEASURE["TRACKED_UNIQUE_SESSIONS"] = "tracked.sessions";
28
+ MEASURE["TRACKED_UNIQUE_VISITORS"] = "tracked.visitors";
29
+ MEASURE["TRACKED_ADD_TO_CART_RATE"] = "tracked.add_to_cart_rate";
30
+ MEASURE["TRACKED_VIEW_CONTENT_RATE"] = "tracked.view_content_rate";
31
+ MEASURE["TRACKED_INITIATE_CHECKOUT_RATE"] = "tracked.initiate_checkout_rate";
32
+ MEASURE["TRACKED_ATC_TO_IC_RATE"] = "tracked.atc_to_ic_rate";
33
+ MEASURE["TRACKED_IC_TO_PURCHASE_RATE"] = "tracked.ic_to_purchase_rate";
34
+ MEASURE["TRACKED_TOTAL_EVENTS"] = "tracked.events_processed";
35
+ MEASURE["SHOPIFY_CUSTOMERS"] = "shopify.customers";
36
+ MEASURE["SHOPIFY_ABANDONED_CHECKOUTS_VALUE"] = "shopify.abandoned_checkouts_value";
37
+ MEASURE["SHOPIFY_ABANDONED_CHECKOUTS"] = "shopify.abandoned_checkouts";
38
+ MEASURE["SHOPIFY_REFUNDS"] = "shopify.refunds_count";
39
+ MEASURE["SHOPIFY_REFUND_REVENUE"] = "shopify.refunds_amount";
40
+ MEASURE["SHOPIFY_REFUND_RATE"] = "shopify.refunds_rate";
41
+ MEASURE["SHOPIFY_DISCOUNTS"] = "shopify.discounts_count";
42
+ MEASURE["SHOPIFY_DISCOUNT_AMOUNT"] = "shopify.discount_amount";
43
+ MEASURE["SHOPIFY_DISCOUNT_RATE"] = "shopify.discounts_rate";
44
+ MEASURE["SHOPIFY_ORDERS"] = "shopify.order_count";
45
+ MEASURE["SHOPIFY_REVENUE"] = "shopify.revenue";
46
+ MEASURE["SHOPIFY_AOV"] = "shopify.average_order_value";
47
+ MEASURE["SHOPIFY_TOP_PRODUCTS"] = "shopify.top_products";
48
+ MEASURE["SHOPIFY_CUSTOMER_LTV"] = "shopify.customer_ltv";
49
+ MEASURE["SHOPIFY_REPEAT_CUSTOMER_RATE"] = "shopify.repeat_customer_rate";
50
+ MEASURE["SHOPIFY_TAX_AMOUNT"] = "shopify.tax_amount";
51
+ MEASURE["SHOPIFY_SHIPPING_AMOUNT"] = "shopify.shipping_amount";
52
+ MEASURE["SHOPIFY_SUBTOTAL_AMOUNT"] = "shopify.subtotal_amount";
53
+ MEASURE["SHOPIFY_NEW_CUSTOMER_RATE"] = "shopify.new_customer_rate";
54
+ MEASURE["SHOPIFY_RETURNING_CUSTOMER_RATE"] = "shopify.new_customer_rate";
55
+ MEASURE["SITE_TTFB"] = "site.ttfb";
56
+ MEASURE["SITE_FCP"] = "site.fcp";
57
+ MEASURE["SITE_LCP"] = "site.lcp";
58
+ MEASURE["SITE_TIME_ON_SITE"] = "site.time_on_site";
59
+ })(MEASURE = exports.MEASURE || (exports.MEASURE = {}));
60
+ var DIMENSION;
61
+ (function (DIMENSION) {
62
+ DIMENSION["DEVICE_MODEL"] = "device_model";
63
+ DIMENSION["DEVICE_VENDOR"] = "device_vendor";
64
+ DIMENSION["DEVICE_TYPE"] = "device_type";
65
+ DIMENSION["BROWSER"] = "browser";
66
+ DIMENSION["BROWSER_VERSION"] = "browser_version";
67
+ DIMENSION["BROWSER_OS"] = "browser_os";
68
+ DIMENSION["OS"] = "OS";
69
+ DIMENSION["LANDING_PATH"] = "landing_path";
70
+ DIMENSION["PAGE_PATH"] = "path";
71
+ DIMENSION["PAGE_TITLE"] = "title";
72
+ DIMENSION["QUERY_STRING"] = "query";
73
+ DIMENSION["GATEWAY"] = "gateway";
74
+ DIMENSION["CURRENCY"] = "currency";
75
+ DIMENSION["SHIPPING_CODE"] = "shipping_code";
76
+ DIMENSION["IS_MOBILE"] = "is_mobile";
77
+ DIMENSION["IS_WIRELESS"] = "is_wireless";
78
+ DIMENSION["CITY"] = "city";
79
+ DIMENSION["PROVINCE_CODE"] = "province_code";
80
+ DIMENSION["PROVINCE"] = "province";
81
+ DIMENSION["COUNTRY_CODE"] = "country_code";
82
+ DIMENSION["COUNTRY"] = "country";
83
+ DIMENSION["POSTAL_CODE"] = "postal_code";
84
+ DIMENSION["FINANCIAL_STATUS"] = "financial_status";
85
+ DIMENSION["FULFILLMENT_STATUS"] = "fulfillment_status";
86
+ DIMENSION["DISCOUNT_CODE"] = "discount_code";
87
+ DIMENSION["REFERRER"] = "referrer";
88
+ DIMENSION["REFERRER_MEDIUM"] = "referrer_medium";
89
+ DIMENSION["REFERRER_SOURCE"] = "referrer_source";
90
+ DIMENSION["REFERRER_TERM"] = "referrer_term";
91
+ DIMENSION["UTM_CAMPAIGN"] = "utm_campaign";
92
+ DIMENSION["UTM_SOURCE"] = "utm_source";
93
+ DIMENSION["UTM_MEDIUM"] = "utm_medium";
94
+ DIMENSION["UTM_TERM"] = "utm_term";
95
+ DIMENSION["UTM_CONTENT"] = "utm_content";
96
+ DIMENSION["CLICK_NETWORK"] = "click_network";
97
+ DIMENSION["ADBLOCK_DETECTED"] = "adblock_detected";
98
+ DIMENSION["TIMEZONE"] = "timezone";
99
+ DIMENSION["LOCALE"] = "locale";
100
+ })(DIMENSION = exports.DIMENSION || (exports.DIMENSION = {}));
101
101
  //# sourceMappingURL=query.js.map