@adtrackify/at-tracking-event-types 3.1.0 → 3.1.1

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 (159) 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 +62 -62
  4. package/dist/cjs/types/api/account.js +23 -23
  5. package/dist/cjs/types/api/contact-acquisition.d.ts +39 -39
  6. package/dist/cjs/types/api/contact-acquisition.js +16 -16
  7. package/dist/cjs/types/api/destination-tracked-events.d.ts +11 -11
  8. package/dist/cjs/types/api/destination-tracked-events.js +3 -3
  9. package/dist/cjs/types/api/destinations/destination-catalog.d.ts +30 -30
  10. package/dist/cjs/types/api/destinations/destination-catalog.js +2 -2
  11. package/dist/cjs/types/api/destinations/destinations.d.ts +93 -93
  12. package/dist/cjs/types/api/destinations/destinations.js +43 -43
  13. package/dist/cjs/types/api/destinations/third-party-contact-acquisition-configs.d.ts +9 -9
  14. package/dist/cjs/types/api/destinations/third-party-contact-acquisition-configs.js +2 -2
  15. package/dist/cjs/types/api/destinations/third-party-destination-configs.d.ts +109 -109
  16. package/dist/cjs/types/api/destinations/third-party-destination-configs.js +9 -9
  17. package/dist/cjs/types/api/destinations/third-party-integration-configs.d.ts +41 -41
  18. package/dist/cjs/types/api/destinations/third-party-integration-configs.js +11 -11
  19. package/dist/cjs/types/api/event-last-seen.d.ts +6 -6
  20. package/dist/cjs/types/api/event-last-seen.js +2 -2
  21. package/dist/cjs/types/api/event-status.d.ts +18 -18
  22. package/dist/cjs/types/api/event-status.js +9 -9
  23. package/dist/cjs/types/api/index.d.ts +17 -17
  24. package/dist/cjs/types/api/index.js +33 -33
  25. package/dist/cjs/types/api/log-events.d.ts +22 -22
  26. package/dist/cjs/types/api/log-events.js +2 -2
  27. package/dist/cjs/types/api/pixel-setup-health.d.ts +19 -19
  28. package/dist/cjs/types/api/pixel-setup-health.js +2 -2
  29. package/dist/cjs/types/api/query.d.ts +232 -230
  30. package/dist/cjs/types/api/query.js +182 -180
  31. package/dist/cjs/types/api/query.js.map +1 -1
  32. package/dist/cjs/types/api/shopify-app-install.d.ts +39 -39
  33. package/dist/cjs/types/api/shopify-app-install.js +14 -14
  34. package/dist/cjs/types/api/subscription.d.ts +155 -155
  35. package/dist/cjs/types/api/subscription.js +47 -47
  36. package/dist/cjs/types/api/tracking-events.d.ts +15 -15
  37. package/dist/cjs/types/api/tracking-events.js +2 -2
  38. package/dist/cjs/types/api/user.d.ts +13 -13
  39. package/dist/cjs/types/api/user.js +2 -2
  40. package/dist/cjs/types/common/address.d.ts +15 -15
  41. package/dist/cjs/types/common/address.js +2 -2
  42. package/dist/cjs/types/common/currency.d.ts +1 -1
  43. package/dist/cjs/types/common/currency.js +63 -63
  44. package/dist/cjs/types/common/index.d.ts +2 -2
  45. package/dist/cjs/types/common/index.js +18 -18
  46. package/dist/cjs/types/event/base/event-name-enum.d.ts +58 -58
  47. package/dist/cjs/types/event/base/event-name-enum.js +64 -64
  48. package/dist/cjs/types/event/base/event.d.ts +20 -20
  49. package/dist/cjs/types/event/base/event.js +10 -10
  50. package/dist/cjs/types/event/base/index.d.ts +2 -2
  51. package/dist/cjs/types/event/base/index.js +18 -18
  52. package/dist/cjs/types/event/context/event-context-identity.d.ts +21 -21
  53. package/dist/cjs/types/event/context/event-context-identity.js +2 -2
  54. package/dist/cjs/types/event/context/event-context.d.ts +182 -182
  55. package/dist/cjs/types/event/context/event-context.js +2 -2
  56. package/dist/cjs/types/event/context/index.d.ts +2 -2
  57. package/dist/cjs/types/event/context/index.js +18 -18
  58. package/dist/cjs/types/event/index.d.ts +5 -5
  59. package/dist/cjs/types/event/index.js +21 -21
  60. package/dist/cjs/types/event/log-event.d.ts +35 -35
  61. package/dist/cjs/types/event/log-event.js +22 -22
  62. package/dist/cjs/types/event/metric-event.d.ts +13 -13
  63. package/dist/cjs/types/event/metric-event.js +2 -2
  64. package/dist/cjs/types/event/tracking-event.d.ts +62 -62
  65. package/dist/cjs/types/event/tracking-event.js +2 -2
  66. package/dist/cjs/types/event-bus-event.d.ts +25 -25
  67. package/dist/cjs/types/event-bus-event.js +2 -2
  68. package/dist/cjs/types/fingerprint/browser-attributes.d.ts +60 -60
  69. package/dist/cjs/types/fingerprint/browser-attributes.js +2 -2
  70. package/dist/cjs/types/fingerprint/index.d.ts +6 -6
  71. package/dist/cjs/types/fingerprint/index.js +18 -18
  72. package/dist/cjs/types/fingerprint/server-attributes.d.ts +50 -50
  73. package/dist/cjs/types/fingerprint/server-attributes.js +2 -2
  74. package/dist/cjs/types/index.d.ts +7 -7
  75. package/dist/cjs/types/index.js +23 -23
  76. package/dist/cjs/types/third-party-event-configuration-types.d.ts +10 -10
  77. package/dist/cjs/types/third-party-event-configuration-types.js +2 -2
  78. package/dist/cjs/types/tracking-event-ingest-message.d.ts +10 -10
  79. package/dist/cjs/types/tracking-event-ingest-message.js +2 -2
  80. package/dist/esm/index.d.ts +1 -1
  81. package/dist/esm/index.js +1 -1
  82. package/dist/esm/types/api/account.d.ts +62 -62
  83. package/dist/esm/types/api/account.js +20 -20
  84. package/dist/esm/types/api/contact-acquisition.d.ts +39 -39
  85. package/dist/esm/types/api/contact-acquisition.js +13 -13
  86. package/dist/esm/types/api/destination-tracked-events.d.ts +11 -11
  87. package/dist/esm/types/api/destination-tracked-events.js +1 -1
  88. package/dist/esm/types/api/destinations/destination-catalog.d.ts +30 -30
  89. package/dist/esm/types/api/destinations/destination-catalog.js +1 -1
  90. package/dist/esm/types/api/destinations/destinations.d.ts +93 -93
  91. package/dist/esm/types/api/destinations/destinations.js +40 -40
  92. package/dist/esm/types/api/destinations/third-party-contact-acquisition-configs.d.ts +9 -9
  93. package/dist/esm/types/api/destinations/third-party-contact-acquisition-configs.js +1 -1
  94. package/dist/esm/types/api/destinations/third-party-destination-configs.d.ts +109 -109
  95. package/dist/esm/types/api/destinations/third-party-destination-configs.js +6 -6
  96. package/dist/esm/types/api/destinations/third-party-integration-configs.d.ts +41 -41
  97. package/dist/esm/types/api/destinations/third-party-integration-configs.js +8 -8
  98. package/dist/esm/types/api/event-last-seen.d.ts +6 -6
  99. package/dist/esm/types/api/event-last-seen.js +1 -1
  100. package/dist/esm/types/api/event-status.d.ts +18 -18
  101. package/dist/esm/types/api/event-status.js +6 -6
  102. package/dist/esm/types/api/index.d.ts +17 -17
  103. package/dist/esm/types/api/index.js +17 -17
  104. package/dist/esm/types/api/log-events.d.ts +22 -22
  105. package/dist/esm/types/api/log-events.js +1 -1
  106. package/dist/esm/types/api/pixel-setup-health.d.ts +19 -19
  107. package/dist/esm/types/api/pixel-setup-health.js +1 -1
  108. package/dist/esm/types/api/query.d.ts +232 -230
  109. package/dist/esm/types/api/query.js +179 -177
  110. package/dist/esm/types/api/query.js.map +1 -1
  111. package/dist/esm/types/api/shopify-app-install.d.ts +39 -39
  112. package/dist/esm/types/api/shopify-app-install.js +11 -11
  113. package/dist/esm/types/api/subscription.d.ts +155 -155
  114. package/dist/esm/types/api/subscription.js +44 -44
  115. package/dist/esm/types/api/tracking-events.d.ts +15 -15
  116. package/dist/esm/types/api/tracking-events.js +1 -1
  117. package/dist/esm/types/api/user.d.ts +13 -13
  118. package/dist/esm/types/api/user.js +1 -1
  119. package/dist/esm/types/common/address.d.ts +15 -15
  120. package/dist/esm/types/common/address.js +1 -1
  121. package/dist/esm/types/common/currency.d.ts +1 -1
  122. package/dist/esm/types/common/currency.js +60 -60
  123. package/dist/esm/types/common/index.d.ts +2 -2
  124. package/dist/esm/types/common/index.js +2 -2
  125. package/dist/esm/types/event/base/event-name-enum.d.ts +58 -58
  126. package/dist/esm/types/event/base/event-name-enum.js +61 -61
  127. package/dist/esm/types/event/base/event.d.ts +20 -20
  128. package/dist/esm/types/event/base/event.js +7 -7
  129. package/dist/esm/types/event/base/index.d.ts +2 -2
  130. package/dist/esm/types/event/base/index.js +2 -2
  131. package/dist/esm/types/event/context/event-context-identity.d.ts +21 -21
  132. package/dist/esm/types/event/context/event-context-identity.js +1 -1
  133. package/dist/esm/types/event/context/event-context.d.ts +182 -182
  134. package/dist/esm/types/event/context/event-context.js +1 -1
  135. package/dist/esm/types/event/context/index.d.ts +2 -2
  136. package/dist/esm/types/event/context/index.js +2 -2
  137. package/dist/esm/types/event/index.d.ts +5 -5
  138. package/dist/esm/types/event/index.js +5 -5
  139. package/dist/esm/types/event/log-event.d.ts +35 -35
  140. package/dist/esm/types/event/log-event.js +19 -19
  141. package/dist/esm/types/event/metric-event.d.ts +13 -13
  142. package/dist/esm/types/event/metric-event.js +1 -1
  143. package/dist/esm/types/event/tracking-event.d.ts +62 -62
  144. package/dist/esm/types/event/tracking-event.js +1 -1
  145. package/dist/esm/types/event-bus-event.d.ts +25 -25
  146. package/dist/esm/types/event-bus-event.js +1 -1
  147. package/dist/esm/types/fingerprint/browser-attributes.d.ts +60 -60
  148. package/dist/esm/types/fingerprint/browser-attributes.js +1 -1
  149. package/dist/esm/types/fingerprint/index.d.ts +6 -6
  150. package/dist/esm/types/fingerprint/index.js +2 -2
  151. package/dist/esm/types/fingerprint/server-attributes.d.ts +50 -50
  152. package/dist/esm/types/fingerprint/server-attributes.js +1 -1
  153. package/dist/esm/types/index.d.ts +7 -7
  154. package/dist/esm/types/index.js +7 -7
  155. package/dist/esm/types/third-party-event-configuration-types.d.ts +10 -10
  156. package/dist/esm/types/third-party-event-configuration-types.js +1 -1
  157. package/dist/esm/types/tracking-event-ingest-message.d.ts +10 -10
  158. package/dist/esm/types/tracking-event-ingest-message.js +1 -1
  159. package/package.json +1 -1
@@ -1,34 +1,34 @@
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-contact-acquisition-configs"), exports);
21
- __exportStar(require("./destinations/third-party-destination-configs"), exports);
22
- __exportStar(require("./destinations/third-party-integration-configs"), exports);
23
- __exportStar(require("./shopify-app-install"), exports);
24
- __exportStar(require("./subscription"), exports);
25
- __exportStar(require("./user"), exports);
26
- __exportStar(require("./query"), exports);
27
- __exportStar(require("./event-status"), exports);
28
- __exportStar(require("./log-events"), exports);
29
- __exportStar(require("./tracking-events"), exports);
30
- __exportStar(require("./destination-tracked-events"), exports);
31
- __exportStar(require("./pixel-setup-health"), exports);
32
- __exportStar(require("./event-last-seen"), exports);
33
- __exportStar(require("./contact-acquisition"), 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-contact-acquisition-configs"), exports);
21
+ __exportStar(require("./destinations/third-party-destination-configs"), exports);
22
+ __exportStar(require("./destinations/third-party-integration-configs"), exports);
23
+ __exportStar(require("./shopify-app-install"), exports);
24
+ __exportStar(require("./subscription"), exports);
25
+ __exportStar(require("./user"), exports);
26
+ __exportStar(require("./query"), exports);
27
+ __exportStar(require("./event-status"), exports);
28
+ __exportStar(require("./log-events"), exports);
29
+ __exportStar(require("./tracking-events"), exports);
30
+ __exportStar(require("./destination-tracked-events"), exports);
31
+ __exportStar(require("./pixel-setup-health"), exports);
32
+ __exportStar(require("./event-last-seen"), exports);
33
+ __exportStar(require("./contact-acquisition"), exports);
34
34
  //# sourceMappingURL=index.js.map
@@ -1,22 +1,22 @@
1
- import { LogEvent, LogLevel } from '../event';
2
- export interface LogEventRecord {
3
- eventId: string;
4
- eventName: string;
5
- pixelId: string;
6
- source: string;
7
- service: string;
8
- logMessage?: string;
9
- logEvent?: LogEvent;
10
- logLevel: LogLevel;
11
- logGroup: string;
12
- destination?: string;
13
- destinationId?: string;
14
- trackingEventName?: string;
15
- destinationTrackingEventName?: string;
16
- responseCode?: number;
17
- errorCode?: string;
18
- errorMessage?: string;
19
- sentAtEpoch?: number;
20
- collectedAt?: string;
21
- expiredAt: number;
22
- }
1
+ import { LogEvent, LogLevel } from '../event';
2
+ export interface LogEventRecord {
3
+ eventId: string;
4
+ eventName: string;
5
+ pixelId: string;
6
+ source: string;
7
+ service: string;
8
+ logMessage?: string;
9
+ logEvent?: LogEvent;
10
+ logLevel: LogLevel;
11
+ logGroup: string;
12
+ destination?: string;
13
+ destinationId?: string;
14
+ trackingEventName?: string;
15
+ destinationTrackingEventName?: string;
16
+ responseCode?: number;
17
+ errorCode?: string;
18
+ errorMessage?: string;
19
+ sentAtEpoch?: number;
20
+ collectedAt?: string;
21
+ expiredAt: number;
22
+ }
@@ -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,19 +1,19 @@
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
- customPixelHealthy: boolean;
13
- }
14
- export interface DestinationHealth {
15
- id: string;
16
- displayName: string;
17
- healthy: boolean;
18
- enabled: boolean;
19
- }
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
+ customPixelHealthy: boolean;
13
+ }
14
+ export interface DestinationHealth {
15
+ id: string;
16
+ displayName: string;
17
+ healthy: boolean;
18
+ enabled: boolean;
19
+ }
@@ -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,230 +1,232 @@
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_PV_TO_VC_RATE = "tracked.pv_to_vc_rate",
32
- TRACKED_VC_TO_ATC_RATE = "tracked.vc_to_atc_rate",
33
- TRACKED_ATC_TO_IC_RATE = "tracked.atc_to_ic_rate",
34
- TRACKED_IC_TO_PURCHASE_RATE = "tracked.ic_to_purchase_rate",
35
- TRACKED_TOTAL_EVENTS = "tracked.events_processed",
36
- TRACKED_AVG_PAGE_VISITS_PER_SESSION = "tracked.avg_page_visits_per_session",
37
- TRACKED_AVG_PAGE_VIEWS_PER_SESSION = "tracked.avg_page_views_per_session",
38
- TRACKED_AVG_VIEW_CONTENTS_PER_SESSION = "tracked.avg_view_contents_per_session",
39
- TRACKED_AVG_SESSIONS_PER_VISITOR = "tracked.avg_sessions_per_visitor",
40
- SHOPIFY_CUSTOMERS = "shopify.customers",
41
- SHOPIFY_ABANDONED_CHECKOUTS_VALUE = "shopify.abandoned_checkouts_value",
42
- SHOPIFY_ABANDONED_CHECKOUTS = "shopify.abandoned_checkouts",
43
- SHOPIFY_CANCELLED_ORDERS = "shopify.cancelled_orders_count",
44
- SHOPIFY_CANCELLED_AMOUNT = "shopify.cancellation_amount",
45
- SHOPIFY_GROSS_SALES = "shopify.gross_sales",
46
- SHOPIFY_NET_SALES = "shopify.net_sales",
47
- SHOPIFY_REFUNDS = "shopify.refunds_count",
48
- SHOPIFY_REFUND_AMOUNT_REFUND_DATE = "shopify.refunds_amount_refund_date",
49
- SHOPIFY_REFUND_AMOUNT_ORDER_DATE = "shopify.refunds_amount_order_date",
50
- SHOPIFY_REFUND_GROSS_PERCENT = "shopify.refunds_gross_percent",
51
- SHOPIFY_REFUND_NET_PERCENT = "shopify.refunds_net_percent",
52
- SHOPIFY_REFUND_RATE = "shopify.refunds_rate",
53
- SHOPIFY_DISCOUNTS = "shopify.discounts_count",
54
- SHOPIFY_DISCOUNT_AMOUNT = "shopify.discount_amount",
55
- SHOPIFY_DISCOUNT_GROSS_PERCENT = "shopify.discounts_gross_percent",
56
- SHOPIFY_DISCOUNT_NET_PERCENT = "shopify.discounts_net_percent",
57
- SHOPIFY_DISCOUNT_RATE = "shopify.discounts_rate",
58
- SHOPIFY_REFUND_PLUS_DISCOUNT_AMOUNT = "shopify.refunds_plus_discount",
59
- SHOPIFY_ORDERS = "shopify.order_count",
60
- SHOPIFY_AVG_ORDERS_PER_CUSTOMER = "shopify.avg_orders_per_customer",
61
- SHOPIFY_REVENUE = "shopify.revenue",
62
- SHOPIFY_SUBTOTAL_AMOUNT = "shopify.subtotal_amount",
63
- SHOPIFY_NET_PLUS_SHIPPING_AMOUNT = "shopify.net_plus_shipping_amount",
64
- SHOPIFY_AOV = "shopify.average_order_value",
65
- SHOPIFY_NET_AOV = "shopify.net_average_order_value",
66
- SHOPIFY_TOP_PRODUCTS = "shopify.top_products",
67
- SHOPIFY_CUSTOMER_LTV = "shopify.customer_ltv",
68
- SHOPIFY_REPEAT_CUSTOMER_RATE = "shopify.repeat_customer_rate",
69
- SHOPIFY_TAX_AMOUNT = "shopify.tax_amount",
70
- SHOPIFY_SHIPPING_AMOUNT = "shopify.shipping_amount",
71
- SHOPIFY_NEW_CUSTOMERS = "shopify.new_customers",
72
- SHOPIFY_NEW_CUSTOMER_GROSS = "shopify.new_customer_gross",
73
- SHOPIFY_NEW_CUSTOMER_GROSS_PERCENT = "shopify.new_customer_gross_percent",
74
- SHOPIFY_NEW_CUSTOMER_NET = "shopify.new_customer_net",
75
- SHOPIFY_NEW_CUSTOMER_AOV = "shopify.new_customer_aov",
76
- SHOPIFY_NEW_CUSTOMER_NET_AOV = "shopify.new_customer_net_aov",
77
- SHOPIFY_NEW_CUSTOMER_RATE = "shopify.new_customer_rate",
78
- SHOPIFY_NEW_CUSTOMER_PURCHASES = "shopify.new_customer_purchases",
79
- SHOPIFY_RETURNING_CUSTOMERS = "shopify.returning_customers",
80
- SHOPIFY_RETURNING_CUSTOMER_AOV = "shopify.returning_customer_aov",
81
- SHOPIFY_RETURNING_CUSTOMER_NET_AOV = "shopify.returning_customer_net_aov",
82
- SHOPIFY_RETURNING_CUSTOMER_RATE = "shopify.returning_customer_rate",
83
- SHOPIFY_LTV = "shopify.lifetime_value",
84
- SHOPIFY_LTV_90 = "shopify.lifetime_value_90",
85
- SHOPIFY_LTV_180 = "shopify.lifetime_value_180",
86
- SHOPIFY_LTV_365 = "shopify.lifetime_value_365",
87
- SHOPIFY_LTV_COHORT_GROSS_SALE_PRICE = "shopify.ltv_cohort_gross_sale_price",
88
- SHOPIFY_LTV_COHORT_NET_SALE_PRICE = "shopify.ltv_cohort_net_sale_price",
89
- SHOPIFY_LTV_COHORT_NETT_SALE_PRICE = "shopify.ltv_cohort_nett_sale_price",
90
- SHOPIFY_LTV_COHORT_NETTS_SALE_PRICE = "shopify.ltv_cohort_netts_sale_price",
91
- SHOPIFY_LTV_COHORT_NETS_SALE_PRICE = "shopify.ltv_cohort_nets_sale_price",
92
- SHOPIFY_CUSTOMERS_COHORT = "shopify.customers_cohort",
93
- SHOPIFY_CUSTOMERS_RETENTION_RATE_COHORT = "shopify.customers_retention_rate_cohort",
94
- SHOPIFY_AVG_ORDER_VALUE_COHORT = "shopify.avg_order_value_cohort",
95
- SITE_TTFB = "site.ttfb",
96
- SITE_FCP = "site.fcp",
97
- SITE_LCP = "site.lcp",
98
- SITE_TIME_ON_SITE = "site.time_on_site",
99
- FB_CPC = "fb.cpc",
100
- FB_CTR = "fb.ctr",
101
- FB_CPM = "fb.cpm",
102
- FB_ROAS = "fb.roas",
103
- FB_SPEND = "fb.spend",
104
- FB_CPA = "fb.cpa",
105
- FB_IMPRESSIONS = "fb.impressions",
106
- FB_CLICKS = "fb.clicks",
107
- FB_PURCHASES = "fb.purchases",
108
- FB_PURCHASE_REVENUE = "fb.purchase_revenue",
109
- FB_NEW_CUSTOMER_CPA = "fb.new_customer_cpa",
110
- FB_NEW_CUSTOMER_ROAS = "fb.new_customer_roas",
111
- FB_SPEND_GROSS_PERCENT = "fb.spend_gross_percent",
112
- FB_SPEND_NET_PERCENT = "fb.spend_net_percent",
113
- FB_MER_GROSS = "fb.mer_gross",
114
- FB_MER_NET = "fb.mer_net",
115
- CPC = "cpc",
116
- CTR = "ctr",
117
- CPM = "cpm",
118
- ROAS = "roas",
119
- AD_SPEND = "ad_spend",
120
- CPA = "cpa",
121
- IMPRESSIONS = "impressions",
122
- CLICKS = "clicks",
123
- PURCHASES = "purchases",
124
- PURCHASE_REVENUE = "purchase_revenue",
125
- NEW_CUSTOMER_CPA = "new_customer_cpa",
126
- NEW_CUSTOMER_ROAS = "new_customer_roas",
127
- SPEND_GROSS_PERCENT = "spend_gross_percent",
128
- SPEND_NET_PERCENT = "spend_net_percent",
129
- MER_GROSS = "mer_gross",
130
- MER_NET = "mer_net",
131
- RRADD = "rradd",
132
- RRADD_GROSS_PERCENT = "rradd_gross_percent"
133
- }
134
- export interface Query {
135
- pixelId: string;
136
- measures: MEASURE[];
137
- dateRange: DateRange;
138
- compareDateRange?: DateRange;
139
- granularity?: GRANULARITY;
140
- dimensions?: DIMENSION[];
141
- filters?: any[];
142
- timezone?: string;
143
- orderSettings?: OrderSettings;
144
- }
145
- export interface OrderSettings {
146
- countVoidedOrders?: boolean;
147
- countPendingOrders?: boolean;
148
- }
149
- export interface AppliedDimensions {
150
- dimensionName?: string;
151
- dimensionValue?: string;
152
- }
153
- export declare type MeasureDataRow = {
154
- [key: string]: any;
155
- dt?: string;
156
- start?: string;
157
- end?: string;
158
- };
159
- export interface QueryData {
160
- primary?: MeasureDataRow[];
161
- compare?: MeasureDataRow[];
162
- }
163
- export interface MeasureDetail {
164
- measure: MEASURE;
165
- isAverage: boolean;
166
- isPercentage: boolean;
167
- calculatedAverage: boolean;
168
- success: boolean;
169
- primaryAvg: number;
170
- compareAvg: number;
171
- primarySum: number;
172
- compareSum: number;
173
- percentDiff: number;
174
- }
175
- export interface QueryResult {
176
- granularity: GRANULARITY;
177
- dimensions: DIMENSION[];
178
- dateRange: DateRange;
179
- compareDateRange?: DateRange;
180
- measureDetails: MeasureDetail[] | null;
181
- data: QueryData | null;
182
- }
183
- export interface QueryResponse {
184
- results: QueryResult[];
185
- }
186
- export declare enum DIMENSION {
187
- DEVICE_MODEL = "device_model",
188
- DEVICE_VENDOR = "device_vendor",
189
- DEVICE_TYPE = "device_type",
190
- BROWSER = "browser",
191
- BROWSER_VERSION = "browser_version",
192
- BROWSER_OS = "browser_os",
193
- OS = "OS",
194
- LANDING_PATH = "landing_path",
195
- PAGE_PATH = "path",
196
- PAGE_TITLE = "title",
197
- QUERY_STRING = "query",
198
- GATEWAY = "gateway",
199
- CURRENCY = "currency",
200
- SHIPPING_CODE = "shipping_code",
201
- IS_MOBILE = "is_mobile",
202
- IS_WIRELESS = "is_wireless",
203
- CITY = "city",
204
- PROVINCE_CODE = "province_code",
205
- PROVINCE = "province",
206
- COUNTRY_CODE = "country_code",
207
- COUNTRY = "country",
208
- POSTAL_CODE = "postal_code",
209
- FINANCIAL_STATUS = "financial_status",
210
- FULFILLMENT_STATUS = "fulfillment_status",
211
- DISCOUNT_CODE = "discount_code",
212
- REFERRER = "referrer",
213
- REFERRER_MEDIUM = "referrer_medium",
214
- REFERRER_SOURCE = "referrer_source",
215
- REFERRER_TERM = "referrer_term",
216
- UTM_CAMPAIGN = "utm_campaign",
217
- UTM_SOURCE = "utm_source",
218
- UTM_MEDIUM = "utm_medium",
219
- UTM_TERM = "utm_term",
220
- UTM_CONTENT = "utm_content",
221
- CLICK_NETWORK = "click_network",
222
- ADBLOCK_DETECTED = "adblock_detected",
223
- TIMEZONE = "timezone",
224
- LOCALE = "locale",
225
- CAMPAIGN = "campaign",
226
- ADSET = "adset",
227
- AD = "ad",
228
- CUSTOMER_TYPE = "customer_type",
229
- AD_SOURCE = "ad_source"
230
- }
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_PV_TO_VC_RATE = "tracked.pv_to_vc_rate",
32
+ TRACKED_VC_TO_ATC_RATE = "tracked.vc_to_atc_rate",
33
+ TRACKED_ATC_TO_IC_RATE = "tracked.atc_to_ic_rate",
34
+ TRACKED_IC_TO_PURCHASE_RATE = "tracked.ic_to_purchase_rate",
35
+ TRACKED_TOTAL_EVENTS = "tracked.events_processed",
36
+ TRACKED_AVG_PAGE_VISITS_PER_SESSION = "tracked.avg_page_visits_per_session",
37
+ TRACKED_AVG_PAGE_VIEWS_PER_SESSION = "tracked.avg_page_views_per_session",
38
+ TRACKED_AVG_VIEW_CONTENTS_PER_SESSION = "tracked.avg_view_contents_per_session",
39
+ TRACKED_AVG_SESSIONS_PER_VISITOR = "tracked.avg_sessions_per_visitor",
40
+ SHOPIFY_CUSTOMERS = "shopify.customers",
41
+ SHOPIFY_ABANDONED_CHECKOUTS_VALUE = "shopify.abandoned_checkouts_value",
42
+ SHOPIFY_ABANDONED_CHECKOUTS = "shopify.abandoned_checkouts",
43
+ SHOPIFY_CANCELLED_ORDERS = "shopify.cancelled_orders_count",
44
+ SHOPIFY_CANCELLED_AMOUNT = "shopify.cancellation_amount",
45
+ SHOPIFY_GROSS_SALES = "shopify.gross_sales",
46
+ SHOPIFY_NET_SALES = "shopify.net_sales",
47
+ SHOPIFY_REFUNDS = "shopify.refunds_count",
48
+ SHOPIFY_REFUND_AMOUNT_REFUND_DATE = "shopify.refunds_amount_refund_date",
49
+ SHOPIFY_REFUND_AMOUNT_ORDER_DATE = "shopify.refunds_amount_order_date",
50
+ SHOPIFY_REFUND_GROSS_PERCENT = "shopify.refunds_gross_percent",
51
+ SHOPIFY_REFUND_NET_PERCENT = "shopify.refunds_net_percent",
52
+ SHOPIFY_REFUND_RATE = "shopify.refunds_rate",
53
+ SHOPIFY_DISCOUNTS = "shopify.discounts_count",
54
+ SHOPIFY_DISCOUNT_AMOUNT = "shopify.discount_amount",
55
+ SHOPIFY_DISCOUNT_GROSS_PERCENT = "shopify.discounts_gross_percent",
56
+ SHOPIFY_DISCOUNT_NET_PERCENT = "shopify.discounts_net_percent",
57
+ SHOPIFY_DISCOUNT_RATE = "shopify.discounts_rate",
58
+ SHOPIFY_REFUND_PLUS_DISCOUNT_AMOUNT = "shopify.refunds_plus_discount",
59
+ SHOPIFY_ORDERS = "shopify.order_count",
60
+ SHOPIFY_AVG_ORDERS_PER_CUSTOMER = "shopify.avg_orders_per_customer",
61
+ SHOPIFY_REVENUE = "shopify.revenue",
62
+ SHOPIFY_SUBTOTAL_AMOUNT = "shopify.subtotal_amount",
63
+ SHOPIFY_NET_PLUS_SHIPPING_AMOUNT = "shopify.net_plus_shipping_amount",
64
+ SHOPIFY_AOV = "shopify.average_order_value",
65
+ SHOPIFY_NET_AOV = "shopify.net_average_order_value",
66
+ SHOPIFY_TOP_PRODUCTS = "shopify.top_products",
67
+ SHOPIFY_CUSTOMER_LTV = "shopify.customer_ltv",
68
+ SHOPIFY_REPEAT_CUSTOMER_RATE = "shopify.repeat_customer_rate",
69
+ SHOPIFY_TAX_AMOUNT = "shopify.tax_amount",
70
+ SHOPIFY_SHIPPING_AMOUNT = "shopify.shipping_amount",
71
+ SHOPIFY_NEW_CUSTOMERS = "shopify.new_customers",
72
+ SHOPIFY_NEW_CUSTOMER_GROSS = "shopify.new_customer_gross",
73
+ SHOPIFY_NEW_CUSTOMER_GROSS_PERCENT = "shopify.new_customer_gross_percent",
74
+ SHOPIFY_NEW_CUSTOMER_NET = "shopify.new_customer_net",
75
+ SHOPIFY_NEW_CUSTOMER_AOV = "shopify.new_customer_aov",
76
+ SHOPIFY_NEW_CUSTOMER_NET_AOV = "shopify.new_customer_net_aov",
77
+ SHOPIFY_NEW_CUSTOMER_RATE = "shopify.new_customer_rate",
78
+ SHOPIFY_NEW_CUSTOMER_PURCHASES = "shopify.new_customer_purchases",
79
+ SHOPIFY_RETURNING_CUSTOMERS = "shopify.returning_customers",
80
+ SHOPIFY_RETURNING_CUSTOMER_AOV = "shopify.returning_customer_aov",
81
+ SHOPIFY_RETURNING_CUSTOMER_NET_AOV = "shopify.returning_customer_net_aov",
82
+ SHOPIFY_RETURNING_CUSTOMER_RATE = "shopify.returning_customer_rate",
83
+ SHOPIFY_LTV = "shopify.lifetime_value",
84
+ SHOPIFY_LTV_90 = "shopify.lifetime_value_90",
85
+ SHOPIFY_LTV_180 = "shopify.lifetime_value_180",
86
+ SHOPIFY_LTV_365 = "shopify.lifetime_value_365",
87
+ SHOPIFY_LTV_COHORT_GROSS_SALE_PRICE = "shopify.ltv_cohort_gross_sale_price",
88
+ SHOPIFY_LTV_COHORT_NET_SALE_PRICE = "shopify.ltv_cohort_net_sale_price",
89
+ SHOPIFY_LTV_COHORT_NETT_SALE_PRICE = "shopify.ltv_cohort_nett_sale_price",
90
+ SHOPIFY_LTV_COHORT_NETTS_SALE_PRICE = "shopify.ltv_cohort_netts_sale_price",
91
+ SHOPIFY_LTV_COHORT_NETS_SALE_PRICE = "shopify.ltv_cohort_nets_sale_price",
92
+ SHOPIFY_CUSTOMERS_COHORT = "shopify.customers_cohort",
93
+ SHOPIFY_CUSTOMERS_RETENTION_RATE_COHORT = "shopify.customers_retention_rate_cohort",
94
+ SHOPIFY_AVG_ORDER_VALUE_COHORT = "shopify.avg_order_value_cohort",
95
+ SITE_TTFB = "site.ttfb",
96
+ SITE_FCP = "site.fcp",
97
+ SITE_LCP = "site.lcp",
98
+ SITE_TIME_ON_SITE = "site.time_on_site",
99
+ FB_CPC = "fb.cpc",
100
+ FB_CTR = "fb.ctr",
101
+ FB_CPM = "fb.cpm",
102
+ FB_ROAS = "fb.roas",
103
+ FB_SPEND = "fb.spend",
104
+ FB_CPA = "fb.cpa",
105
+ FB_IMPRESSIONS = "fb.impressions",
106
+ FB_CLICKS = "fb.clicks",
107
+ FB_PURCHASES = "fb.purchases",
108
+ FB_PURCHASE_REVENUE = "fb.purchase_revenue",
109
+ FB_NEW_CUSTOMER_CPA = "fb.new_customer_cpa",
110
+ FB_NEW_CUSTOMER_ROAS = "fb.new_customer_roas",
111
+ FB_SPEND_GROSS_PERCENT = "fb.spend_gross_percent",
112
+ FB_SPEND_NET_PERCENT = "fb.spend_net_percent",
113
+ FB_MER_GROSS = "fb.mer_gross",
114
+ FB_MER_NET = "fb.mer_net",
115
+ CPC = "cpc",
116
+ CTR = "ctr",
117
+ CPM = "cpm",
118
+ ROAS = "roas",
119
+ AD_SPEND = "ad_spend",
120
+ CPA = "cpa",
121
+ IMPRESSIONS = "impressions",
122
+ CLICKS = "clicks",
123
+ PURCHASES = "purchases",
124
+ PURCHASE_REVENUE = "purchase_revenue",
125
+ NEW_CUSTOMER_CPA = "new_customer_cpa",
126
+ NEW_CUSTOMER_ROAS = "new_customer_roas",
127
+ SPEND_GROSS_PERCENT = "spend_gross_percent",
128
+ SPEND_NET_PERCENT = "spend_net_percent",
129
+ MER_GROSS = "mer_gross",
130
+ MER_NET = "mer_net",
131
+ RRADD = "rradd",
132
+ RRADD_GROSS_PERCENT = "rradd_gross_percent"
133
+ }
134
+ export interface Query {
135
+ pixelId: string;
136
+ measures: MEASURE[];
137
+ dateRange: DateRange;
138
+ compareDateRange?: DateRange;
139
+ granularity?: GRANULARITY;
140
+ dimensions?: DIMENSION[];
141
+ filters?: any[];
142
+ timezone?: string;
143
+ orderSettings?: OrderSettings;
144
+ }
145
+ export interface OrderSettings {
146
+ countVoidedOrders?: boolean;
147
+ countPendingOrders?: boolean;
148
+ }
149
+ export interface AppliedDimensions {
150
+ dimensionName?: string;
151
+ dimensionValue?: string;
152
+ }
153
+ export declare type MeasureDataRow = {
154
+ [key: string]: any;
155
+ dt?: string;
156
+ start?: string;
157
+ end?: string;
158
+ };
159
+ export interface QueryData {
160
+ primary?: MeasureDataRow[];
161
+ compare?: MeasureDataRow[];
162
+ }
163
+ export interface MeasureDetail {
164
+ measure: MEASURE;
165
+ isAverage: boolean;
166
+ isPercentage: boolean;
167
+ calculatedAverage: boolean;
168
+ success: boolean;
169
+ primaryAvg: number;
170
+ compareAvg: number;
171
+ primarySum: number;
172
+ compareSum: number;
173
+ percentDiff: number;
174
+ }
175
+ export interface QueryResult {
176
+ granularity: GRANULARITY;
177
+ dimensions: DIMENSION[];
178
+ dateRange: DateRange;
179
+ compareDateRange?: DateRange;
180
+ measureDetails: MeasureDetail[] | null;
181
+ data: QueryData | null;
182
+ }
183
+ export interface QueryResponse {
184
+ results: QueryResult[];
185
+ }
186
+ export declare enum DIMENSION {
187
+ DEVICE_MODEL = "device_model",
188
+ DEVICE_VENDOR = "device_vendor",
189
+ DEVICE_TYPE = "device_type",
190
+ BROWSER = "browser",
191
+ BROWSER_VERSION = "browser_version",
192
+ BROWSER_OS = "browser_os",
193
+ OS = "OS",
194
+ LANDING_PATH = "landing_path",
195
+ PAGE_PATH = "path",
196
+ PAGE_TITLE = "title",
197
+ QUERY_STRING = "query",
198
+ GATEWAY = "gateway",
199
+ CURRENCY = "currency",
200
+ SHIPPING_CODE = "shipping_code",
201
+ IS_MOBILE = "is_mobile",
202
+ IS_WIRELESS = "is_wireless",
203
+ CITY = "city",
204
+ PROVINCE_CODE = "province_code",
205
+ PROVINCE = "province",
206
+ COUNTRY_CODE = "country_code",
207
+ COUNTRY = "country",
208
+ POSTAL_CODE = "postal_code",
209
+ FINANCIAL_STATUS = "financial_status",
210
+ FULFILLMENT_STATUS = "fulfillment_status",
211
+ DISCOUNT_CODE = "discount_code",
212
+ REFERRER = "referrer",
213
+ REFERRER_MEDIUM = "referrer_medium",
214
+ REFERRER_SOURCE = "referrer_source",
215
+ REFERRER_TERM = "referrer_term",
216
+ UTM_CAMPAIGN = "utm_campaign",
217
+ UTM_SOURCE = "utm_source",
218
+ UTM_MEDIUM = "utm_medium",
219
+ UTM_TERM = "utm_term",
220
+ UTM_CONTENT = "utm_content",
221
+ CLICK_NETWORK = "click_network",
222
+ ADBLOCK_DETECTED = "adblock_detected",
223
+ TIMEZONE = "timezone",
224
+ LOCALE = "locale",
225
+ CAMPAIGN = "campaign",
226
+ ADSET = "adset",
227
+ AD = "ad",
228
+ CUSTOMER_TYPE = "customer_type",
229
+ AD_SOURCE = "ad_source",
230
+ PRODUCT = "product",
231
+ VARIANT = "variant"
232
+ }