@adtrackify/at-tracking-event-types 3.1.26 → 3.1.28

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 (161) 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 +106 -109
  16. package/dist/cjs/types/api/destinations/third-party-destination-configs.js +9 -9
  17. package/dist/cjs/types/api/destinations/third-party-destination-configs.js.map +1 -1
  18. package/dist/cjs/types/api/destinations/third-party-integration-configs.d.ts +60 -60
  19. package/dist/cjs/types/api/destinations/third-party-integration-configs.js +11 -11
  20. package/dist/cjs/types/api/event-last-seen.d.ts +6 -6
  21. package/dist/cjs/types/api/event-last-seen.js +2 -2
  22. package/dist/cjs/types/api/event-status.d.ts +18 -18
  23. package/dist/cjs/types/api/event-status.js +9 -9
  24. package/dist/cjs/types/api/index.d.ts +17 -17
  25. package/dist/cjs/types/api/index.js +33 -33
  26. package/dist/cjs/types/api/log-events.d.ts +22 -22
  27. package/dist/cjs/types/api/log-events.js +2 -2
  28. package/dist/cjs/types/api/pixel-setup-health.d.ts +19 -19
  29. package/dist/cjs/types/api/pixel-setup-health.js +2 -2
  30. package/dist/cjs/types/api/query.d.ts +298 -279
  31. package/dist/cjs/types/api/query.js +243 -224
  32. package/dist/cjs/types/api/query.js.map +1 -1
  33. package/dist/cjs/types/api/shopify-app-install.d.ts +40 -40
  34. package/dist/cjs/types/api/shopify-app-install.js +14 -14
  35. package/dist/cjs/types/api/subscription.d.ts +155 -155
  36. package/dist/cjs/types/api/subscription.js +47 -47
  37. package/dist/cjs/types/api/tracking-events.d.ts +15 -15
  38. package/dist/cjs/types/api/tracking-events.js +2 -2
  39. package/dist/cjs/types/api/user.d.ts +13 -13
  40. package/dist/cjs/types/api/user.js +2 -2
  41. package/dist/cjs/types/common/address.d.ts +15 -15
  42. package/dist/cjs/types/common/address.js +2 -2
  43. package/dist/cjs/types/common/currency.d.ts +1 -1
  44. package/dist/cjs/types/common/currency.js +63 -63
  45. package/dist/cjs/types/common/index.d.ts +2 -2
  46. package/dist/cjs/types/common/index.js +18 -18
  47. package/dist/cjs/types/event/base/event-name-enum.d.ts +59 -59
  48. package/dist/cjs/types/event/base/event-name-enum.js +65 -65
  49. package/dist/cjs/types/event/base/event.d.ts +20 -20
  50. package/dist/cjs/types/event/base/event.js +10 -10
  51. package/dist/cjs/types/event/base/index.d.ts +2 -2
  52. package/dist/cjs/types/event/base/index.js +18 -18
  53. package/dist/cjs/types/event/context/event-context-identity.d.ts +21 -21
  54. package/dist/cjs/types/event/context/event-context-identity.js +2 -2
  55. package/dist/cjs/types/event/context/event-context.d.ts +196 -190
  56. package/dist/cjs/types/event/context/event-context.js +2 -2
  57. package/dist/cjs/types/event/context/index.d.ts +2 -2
  58. package/dist/cjs/types/event/context/index.js +18 -18
  59. package/dist/cjs/types/event/index.d.ts +5 -5
  60. package/dist/cjs/types/event/index.js +21 -21
  61. package/dist/cjs/types/event/log-event.d.ts +35 -35
  62. package/dist/cjs/types/event/log-event.js +22 -22
  63. package/dist/cjs/types/event/metric-event.d.ts +13 -13
  64. package/dist/cjs/types/event/metric-event.js +2 -2
  65. package/dist/cjs/types/event/tracking-event.d.ts +62 -62
  66. package/dist/cjs/types/event/tracking-event.js +2 -2
  67. package/dist/cjs/types/event-bus-event.d.ts +25 -25
  68. package/dist/cjs/types/event-bus-event.js +2 -2
  69. package/dist/cjs/types/fingerprint/browser-attributes.d.ts +60 -60
  70. package/dist/cjs/types/fingerprint/browser-attributes.js +2 -2
  71. package/dist/cjs/types/fingerprint/index.d.ts +6 -6
  72. package/dist/cjs/types/fingerprint/index.js +18 -18
  73. package/dist/cjs/types/fingerprint/server-attributes.d.ts +50 -50
  74. package/dist/cjs/types/fingerprint/server-attributes.js +2 -2
  75. package/dist/cjs/types/index.d.ts +7 -7
  76. package/dist/cjs/types/index.js +23 -23
  77. package/dist/cjs/types/third-party-event-configuration-types.d.ts +10 -10
  78. package/dist/cjs/types/third-party-event-configuration-types.js +2 -2
  79. package/dist/cjs/types/tracking-event-ingest-message.d.ts +10 -10
  80. package/dist/cjs/types/tracking-event-ingest-message.js +2 -2
  81. package/dist/esm/index.d.ts +1 -1
  82. package/dist/esm/index.js +1 -1
  83. package/dist/esm/types/api/account.d.ts +62 -62
  84. package/dist/esm/types/api/account.js +20 -20
  85. package/dist/esm/types/api/contact-acquisition.d.ts +39 -39
  86. package/dist/esm/types/api/contact-acquisition.js +13 -13
  87. package/dist/esm/types/api/destination-tracked-events.d.ts +11 -11
  88. package/dist/esm/types/api/destination-tracked-events.js +1 -1
  89. package/dist/esm/types/api/destinations/destination-catalog.d.ts +30 -30
  90. package/dist/esm/types/api/destinations/destination-catalog.js +1 -1
  91. package/dist/esm/types/api/destinations/destinations.d.ts +93 -93
  92. package/dist/esm/types/api/destinations/destinations.js +40 -40
  93. package/dist/esm/types/api/destinations/third-party-contact-acquisition-configs.d.ts +9 -9
  94. package/dist/esm/types/api/destinations/third-party-contact-acquisition-configs.js +1 -1
  95. package/dist/esm/types/api/destinations/third-party-destination-configs.d.ts +106 -109
  96. package/dist/esm/types/api/destinations/third-party-destination-configs.js +6 -6
  97. package/dist/esm/types/api/destinations/third-party-destination-configs.js.map +1 -1
  98. package/dist/esm/types/api/destinations/third-party-integration-configs.d.ts +60 -60
  99. package/dist/esm/types/api/destinations/third-party-integration-configs.js +8 -8
  100. package/dist/esm/types/api/event-last-seen.d.ts +6 -6
  101. package/dist/esm/types/api/event-last-seen.js +1 -1
  102. package/dist/esm/types/api/event-status.d.ts +18 -18
  103. package/dist/esm/types/api/event-status.js +6 -6
  104. package/dist/esm/types/api/index.d.ts +17 -17
  105. package/dist/esm/types/api/index.js +17 -17
  106. package/dist/esm/types/api/log-events.d.ts +22 -22
  107. package/dist/esm/types/api/log-events.js +1 -1
  108. package/dist/esm/types/api/pixel-setup-health.d.ts +19 -19
  109. package/dist/esm/types/api/pixel-setup-health.js +1 -1
  110. package/dist/esm/types/api/query.d.ts +298 -279
  111. package/dist/esm/types/api/query.js +240 -221
  112. package/dist/esm/types/api/query.js.map +1 -1
  113. package/dist/esm/types/api/shopify-app-install.d.ts +40 -40
  114. package/dist/esm/types/api/shopify-app-install.js +11 -11
  115. package/dist/esm/types/api/subscription.d.ts +155 -155
  116. package/dist/esm/types/api/subscription.js +44 -44
  117. package/dist/esm/types/api/tracking-events.d.ts +15 -15
  118. package/dist/esm/types/api/tracking-events.js +1 -1
  119. package/dist/esm/types/api/user.d.ts +13 -13
  120. package/dist/esm/types/api/user.js +1 -1
  121. package/dist/esm/types/common/address.d.ts +15 -15
  122. package/dist/esm/types/common/address.js +1 -1
  123. package/dist/esm/types/common/currency.d.ts +1 -1
  124. package/dist/esm/types/common/currency.js +60 -60
  125. package/dist/esm/types/common/index.d.ts +2 -2
  126. package/dist/esm/types/common/index.js +2 -2
  127. package/dist/esm/types/event/base/event-name-enum.d.ts +59 -59
  128. package/dist/esm/types/event/base/event-name-enum.js +62 -62
  129. package/dist/esm/types/event/base/event.d.ts +20 -20
  130. package/dist/esm/types/event/base/event.js +7 -7
  131. package/dist/esm/types/event/base/index.d.ts +2 -2
  132. package/dist/esm/types/event/base/index.js +2 -2
  133. package/dist/esm/types/event/context/event-context-identity.d.ts +21 -21
  134. package/dist/esm/types/event/context/event-context-identity.js +1 -1
  135. package/dist/esm/types/event/context/event-context.d.ts +196 -190
  136. package/dist/esm/types/event/context/event-context.js +1 -1
  137. package/dist/esm/types/event/context/index.d.ts +2 -2
  138. package/dist/esm/types/event/context/index.js +2 -2
  139. package/dist/esm/types/event/index.d.ts +5 -5
  140. package/dist/esm/types/event/index.js +5 -5
  141. package/dist/esm/types/event/log-event.d.ts +35 -35
  142. package/dist/esm/types/event/log-event.js +19 -19
  143. package/dist/esm/types/event/metric-event.d.ts +13 -13
  144. package/dist/esm/types/event/metric-event.js +1 -1
  145. package/dist/esm/types/event/tracking-event.d.ts +62 -62
  146. package/dist/esm/types/event/tracking-event.js +1 -1
  147. package/dist/esm/types/event-bus-event.d.ts +25 -25
  148. package/dist/esm/types/event-bus-event.js +1 -1
  149. package/dist/esm/types/fingerprint/browser-attributes.d.ts +60 -60
  150. package/dist/esm/types/fingerprint/browser-attributes.js +1 -1
  151. package/dist/esm/types/fingerprint/index.d.ts +6 -6
  152. package/dist/esm/types/fingerprint/index.js +2 -2
  153. package/dist/esm/types/fingerprint/server-attributes.d.ts +50 -50
  154. package/dist/esm/types/fingerprint/server-attributes.js +1 -1
  155. package/dist/esm/types/index.d.ts +7 -7
  156. package/dist/esm/types/index.js +7 -7
  157. package/dist/esm/types/third-party-event-configuration-types.d.ts +10 -10
  158. package/dist/esm/types/third-party-event-configuration-types.js +1 -1
  159. package/dist/esm/types/tracking-event-ingest-message.d.ts +10 -10
  160. package/dist/esm/types/tracking-event-ingest-message.js +1 -1
  161. package/package.json +1 -1
@@ -1,279 +1,298 @@
1
- export interface DateRange {
2
- start: string;
3
- end: string;
4
- timezone?: string;
5
- utcStart?: string;
6
- utcEnd?: string;
7
- }
8
- export declare enum GRANULARITY {
9
- NONE = "none",
10
- SECOND = "second",
11
- MINUTE = "minute",
12
- HOUR = "hour",
13
- DAY = "day",
14
- WEEK = "week",
15
- MONTH = "month",
16
- QUARTER = "quarter",
17
- YEAR = "year"
18
- }
19
- export declare enum MEASURE {
20
- TRACKED_PAGE_VIEWS = "tracked.page_views",
21
- TRACKED_VIEW_CONTENTS = "tracked.view_contents",
22
- TRACKED_ADD_TO_CARTS = "tracked.add_to_carts",
23
- TRACKED_INITIATE_CHECKOUTS = "tracked.initiate_checkouts",
24
- TRACKED_PURCHASES = "tracked.purchases",
25
- TRACKED_REVENUE = "tracked.revenue",
26
- TRACKED_SESSION_CONVERSION_RATE = "tracked.session_conversion_rate",
27
- TRACKED_REVENUE_PER_VISITOR = "tracked.revenue_per_visitor",
28
- TRACKED_REVENUE_PER_SESSION = "tracked.revenue_per_session",
29
- TRACKED_UNIQUE_SESSIONS = "tracked.sessions",
30
- TRACKED_UNIQUE_VISITORS = "tracked.visitors",
31
- TRACKED_ADD_TO_CART_RATE = "tracked.add_to_cart_rate",
32
- TRACKED_VIEW_CONTENT_RATE = "tracked.view_content_rate",
33
- TRACKED_INITIATE_CHECKOUT_RATE = "tracked.initiate_checkout_rate",
34
- TRACKED_PV_TO_VC_RATE = "tracked.pv_to_vc_rate",
35
- TRACKED_VC_TO_ATC_RATE = "tracked.vc_to_atc_rate",
36
- TRACKED_ATC_TO_IC_RATE = "tracked.atc_to_ic_rate",
37
- TRACKED_IC_TO_PURCHASE_RATE = "tracked.ic_to_purchase_rate",
38
- TRACKED_TOTAL_EVENTS = "tracked.events_processed",
39
- TRACKED_AVG_PAGE_VISITS_PER_SESSION = "tracked.avg_page_visits_per_session",
40
- TRACKED_AVG_PAGE_VIEWS_PER_SESSION = "tracked.avg_page_views_per_session",
41
- TRACKED_AVG_VIEW_CONTENTS_PER_SESSION = "tracked.avg_view_contents_per_session",
42
- TRACKED_AVG_SESSIONS_PER_VISITOR = "tracked.avg_sessions_per_visitor",
43
- TRACKED_EVENTS = "tracked.events_count",
44
- TRACKED_EVENTS_VALUE = "tracked.events_value",
45
- SHOPIFY_CUSTOMERS = "shopify.customers",
46
- SHOPIFY_ABANDONED_CHECKOUTS_VALUE = "shopify.abandoned_checkouts_value",
47
- SHOPIFY_ABANDONED_CHECKOUTS = "shopify.abandoned_checkouts",
48
- SHOPIFY_CANCELLED_ORDERS = "shopify.cancelled_orders_count",
49
- SHOPIFY_CANCELLED_AMOUNT = "shopify.cancellation_amount",
50
- SHOPIFY_GROSS_SALES = "shopify.gross_sales",
51
- SHOPIFY_NET_SALES = "shopify.net_sales",
52
- SHOPIFY_REFUNDS = "shopify.refunds_count",
53
- SHOPIFY_REFUND_AMOUNT_REFUND_DATE = "shopify.refunds_amount_refund_date",
54
- SHOPIFY_REFUND_AMOUNT_ORDER_DATE = "shopify.refunds_amount_order_date",
55
- SHOPIFY_REFUND_GROSS_PERCENT = "shopify.refunds_gross_percent",
56
- SHOPIFY_REFUND_NET_PERCENT = "shopify.refunds_net_percent",
57
- SHOPIFY_REFUND_RATE = "shopify.refunds_rate",
58
- SHOPIFY_DISCOUNTS = "shopify.discounts_count",
59
- SHOPIFY_DISCOUNT_AMOUNT = "shopify.discount_amount",
60
- SHOPIFY_DISCOUNT_GROSS_PERCENT = "shopify.discounts_gross_percent",
61
- SHOPIFY_DISCOUNT_NET_PERCENT = "shopify.discounts_net_percent",
62
- SHOPIFY_DISCOUNT_RATE = "shopify.discounts_rate",
63
- SHOPIFY_REFUND_PLUS_DISCOUNT_AMOUNT = "shopify.refunds_plus_discount",
64
- SHOPIFY_ORDERS = "shopify.order_count",
65
- SHOPIFY_AVG_ORDERS_PER_CUSTOMER = "shopify.avg_orders_per_customer",
66
- SHOPIFY_REVENUE = "shopify.revenue",
67
- SHOPIFY_SUBTOTAL_AMOUNT = "shopify.subtotal_amount",
68
- SHOPIFY_TOTAL_AMOUNT = "shopify.total_amount",
69
- SHOPIFY_NET_PLUS_SHIPPING_AMOUNT = "shopify.net_plus_shipping_amount",
70
- SHOPIFY_AOV = "shopify.average_order_value",
71
- SHOPIFY_NET_AOV = "shopify.net_average_order_value",
72
- SHOPIFY_TOP_PRODUCTS = "shopify.top_products",
73
- SHOPIFY_PRODUCT_UNITS_SOLD = "shopify.product_units_sold",
74
- SHOPIFY_CUSTOMER_LTV = "shopify.customer_ltv",
75
- SHOPIFY_REPEAT_CUSTOMER_RATE = "shopify.repeat_customer_rate",
76
- SHOPIFY_TAX_AMOUNT = "shopify.tax_amount",
77
- SHOPIFY_SHIPPING_AMOUNT = "shopify.shipping_amount",
78
- SHOPIFY_NEW_CUSTOMERS = "shopify.new_customers",
79
- SHOPIFY_NEW_CUSTOMER_GROSS_SALES = "shopify.new_customer_gross_sales",
80
- SHOPIFY_NEW_CUSTOMER_GROSS_PERCENT = "shopify.new_customer_gross_percent",
81
- SHOPIFY_NEW_CUSTOMER_NET_SALES = "shopify.new_customer_net_sales",
82
- SHOPIFY_NEW_CUSTOMER_AOV = "shopify.new_customer_aov",
83
- SHOPIFY_NEW_CUSTOMER_NET_AOV = "shopify.new_customer_net_aov",
84
- SHOPIFY_NEW_CUSTOMER_TOTAL_SALES = "shopify.new_customer_total_sales",
85
- SHOPIFY_NEW_CUSTOMER_RATE = "shopify.new_customer_rate",
86
- SHOPIFY_NEW_CUSTOMER_PURCHASES = "shopify.new_customer_purchases",
87
- SHOPIFY_RETURNING_CUSTOMERS = "shopify.returning_customers",
88
- SHOPIFY_RETURNING_CUSTOMER_AOV = "shopify.returning_customer_aov",
89
- SHOPIFY_RETURNING_CUSTOMER_NET_AOV = "shopify.returning_customer_net_aov",
90
- SHOPIFY_RETURNING_CUSTOMER_RATE = "shopify.returning_customer_rate",
91
- SHOPIFY_LTV = "shopify.lifetime_value",
92
- SHOPIFY_LTV_90 = "shopify.lifetime_value_90",
93
- SHOPIFY_LTV_180 = "shopify.lifetime_value_180",
94
- SHOPIFY_LTV_365 = "shopify.lifetime_value_365",
95
- SHOPIFY_LTV_COHORT_GROSS_SALE_PRICE = "shopify.ltv_cohort_gross_sale_price",
96
- SHOPIFY_LTV_COHORT_NET_SALE_PRICE = "shopify.ltv_cohort_net_sale_price",
97
- SHOPIFY_LTV_COHORT_NETT_SALE_PRICE = "shopify.ltv_cohort_nett_sale_price",
98
- SHOPIFY_LTV_COHORT_NETTS_SALE_PRICE = "shopify.ltv_cohort_netts_sale_price",
99
- SHOPIFY_LTV_COHORT_NETS_SALE_PRICE = "shopify.ltv_cohort_nets_sale_price",
100
- SHOPIFY_CUSTOMERS_COHORT = "shopify.customers_cohort",
101
- SHOPIFY_CUSTOMERS_RETENTION_RATE_COHORT = "shopify.customers_retention_rate_cohort",
102
- SHOPIFY_AVG_ORDER_VALUE_COHORT = "shopify.avg_order_value_cohort",
103
- SITE_TTFB = "site.ttfb",
104
- SITE_FCP = "site.fcp",
105
- SITE_LCP = "site.lcp",
106
- SITE_TIME_ON_SITE = "site.time_on_site",
107
- FB_CPC = "fb.cpc",
108
- FB_CTR = "fb.ctr",
109
- FB_CPM = "fb.cpm",
110
- FB_ROAS = "fb.roas",
111
- FB_SPEND = "fb.spend",
112
- FB_CPA = "fb.cpa",
113
- FB_IMPRESSIONS = "fb.impressions",
114
- FB_CLICKS = "fb.clicks",
115
- FB_FREQUENCY = "fb.frequency",
116
- FB_PURCHASES = "fb.purchases",
117
- FB_PURCHASES_VALUE = "fb.purchase_value",
118
- FB_NEW_CUSTOMER_PURCHASES = "fb.new_customer_purchases",
119
- FB_NEW_CUSTOMER_PURCHASES_VALUE = "fb.new_customer_purchases_value",
120
- FB_NEW_CUSTOMER_CPA = "fb.new_customer_cpa",
121
- FB_NEW_CUSTOMER_ROAS = "fb.new_customer_roas",
122
- FB_SPEND_GROSS_PERCENT = "fb.spend_gross_percent",
123
- FB_SPEND_NET_PERCENT = "fb.spend_net_percent",
124
- FB_MER_GROSS = "fb.mer_gross",
125
- FB_MER_NET = "fb.mer_net",
126
- BLENDED_CPC = "blended.cpc",
127
- BLENDED_CTR = "blended.ctr",
128
- BLENDED_CPM = "blended.cpm",
129
- BLENDED_ROAS = "blended.roas",
130
- BLENDED_AD_SPEND = "blended.ad_spend",
131
- BLENDED_CPA = "blended.cpa",
132
- BLENDED_IMPRESSIONS = "blended.impressions",
133
- BLENDED_CLICKS = "blended.clicks",
134
- BLENDED_FREQUENCY = "blended.frequency",
135
- BLENDED_PURCHASES = "blended.purchases",
136
- BLENDED_PURCHASES_VALUE = "blended.purchases_value",
137
- BLENDED_NEW_CUSTOMER_PURCHASES = "blended.new_customer_purchases",
138
- BLENDED_NEW_CUSTOMER_PURCHASES_VALUE = "blended.new_customer_purchases_value",
139
- BLENDED_NEW_CUSTOMER_CPA = "blended.new_customer_cpa",
140
- BLENDED_NEW_CUSTOMER_ROAS = "blended.new_customer_roas",
141
- BLENDED_SPEND_GROSS_PERCENT = "blended.spend_gross_percent",
142
- BLENDED_SPEND_NET_PERCENT = "blended.spend_net_percent",
143
- BLENDED_MER_GROSS = "blended.mer_gross",
144
- BLENDED_MER_NET = "blended.mer_net",
145
- CORE_CPA = "core.cpa",
146
- CORE_NEW_CUSTOMER_CPA = "core.new_customer_cpa",
147
- CORE_ROAS = "core.roas",
148
- CORE_NEW_CUSTOMER_ROAS = "core.new_customer_roas",
149
- CORE_RRADD = "core.rradd",
150
- CORE_RRADD_GROSS_PERCENT = "core.rradd_gross_percent"
151
- }
152
- export interface Query {
153
- pixelId: string;
154
- measures: MeasureConfig[];
155
- dateRange: DateRange;
156
- compareDateRange?: DateRange;
157
- granularity?: GRANULARITY;
158
- dimensions?: DIMENSION[];
159
- filters?: any[];
160
- timezone?: string;
161
- orderSettings?: OrderSettings;
162
- }
163
- export interface MeasureConfig {
164
- measure: MEASURE;
165
- pacing?: boolean;
166
- }
167
- export interface OrderSettings {
168
- countVoidedOrders?: boolean;
169
- countPendingOrders?: boolean;
170
- }
171
- export interface AppliedDimensions {
172
- dimensionName?: string;
173
- dimensionValue?: string;
174
- }
175
- export declare type MeasureDataRow = {
176
- [key: string]: any;
177
- dt?: string;
178
- start?: string;
179
- end?: string;
180
- };
181
- export interface QueryData {
182
- primary?: MeasureDataRow[];
183
- compare?: MeasureDataRow[];
184
- }
185
- export interface MeasureDetail {
186
- measure: MEASURE;
187
- isAverage: boolean;
188
- isPercentage: boolean;
189
- calculatedAverage: boolean;
190
- success: boolean;
191
- primaryAvg: number;
192
- compareAvg: number;
193
- primarySum: number;
194
- compareSum: number;
195
- percentDiff: number;
196
- hasPacing: boolean;
197
- }
198
- export interface QueryResult {
199
- granularity: GRANULARITY;
200
- dimensions: DIMENSION[];
201
- dateRange: DateRange;
202
- compareDateRange?: DateRange;
203
- measureDetails: MeasureDetail[] | null;
204
- data: QueryData | null;
205
- }
206
- export interface QueryResponse {
207
- results: QueryResult[];
208
- }
209
- export declare enum DIMENSION {
210
- DEVICE_MODEL = "device_model",
211
- DEVICE_VENDOR = "device_vendor",
212
- DEVICE_TYPE = "device_type",
213
- BROWSER = "browser",
214
- BROWSER_VERSION = "browser_version",
215
- BROWSER_OS = "browser_os",
216
- OS = "OS",
217
- LANDING_PATH = "landing_path",
218
- PAGE_PATH = "path",
219
- PAGE_TITLE = "title",
220
- QUERY_STRING = "query",
221
- GATEWAY = "gateway",
222
- CURRENCY = "currency",
223
- SHIPPING_CODE = "shipping_code",
224
- IS_MOBILE = "is_mobile",
225
- IS_WIRELESS = "is_wireless",
226
- CITY = "city",
227
- PROVINCE_CODE = "province_code",
228
- PROVINCE = "province",
229
- COUNTRY_CODE = "country_code",
230
- COUNTRY = "country",
231
- POSTAL_CODE = "postal_code",
232
- FINANCIAL_STATUS = "financial_status",
233
- FULFILLMENT_STATUS = "fulfillment_status",
234
- DISCOUNT_CODE = "discount_code",
235
- REFERRER = "referrer",
236
- REFERRER_MEDIUM = "referrer_medium",
237
- REFERRER_SOURCE = "referrer_source",
238
- REFERRER_TERM = "referrer_term",
239
- UTM_SOURCE = "utm_source",
240
- UTM_CAMPAIGN = "utm_campaign",
241
- UTM_MEDIUM = "utm_medium",
242
- UTM_TERM = "utm_term",
243
- UTM_CONTENT = "utm_content",
244
- UTM_SOURCE_MEDIUM = "utm_source_medium",
245
- UTM_SOURCE_CAMPAIGN = "utm_source_campaign",
246
- UTM_ADSET = "utm_adset",
247
- UTM_AD = "utm_ad",
248
- CLICK_NETWORK = "click_network",
249
- ADBLOCK_DETECTED = "adblock_detected",
250
- TIMEZONE = "timezone",
251
- LOCALE = "locale",
252
- CAMPAIGN = "campaign",
253
- ADSET = "adset",
254
- AD = "ad",
255
- CUSTOMER_TYPE = "customer_type",
256
- AD_SOURCE = "ad_source",
257
- PRODUCT = "product",
258
- VARIANT = "variant",
259
- ORDER = "order",
260
- NEW_CUSTOMER_ORDER = "new_customer_order"
261
- }
262
- export declare enum FIELDS {
263
- SHOPIFY_ORDER_ID = "shopify.order_id",
264
- SHOPIFY_ORDER_NAME = "shopify.order_name",
265
- SHOPIFY_ORDER_CREATED_DATE = "shopify.order_created_date",
266
- SHOPIFY_ORDER_IS_NEW_CUSTOMER = "shopify.order_is_new_customer",
267
- SHOPIFY_ORDER_CUSTOMER_EMAIL = "shopify.order_customer_email",
268
- SHOPIFY_ORDER_CUSTOMER_PHONE = "shopify.order_customer_phone",
269
- TRACKED_CONVERSION_TOUCHPOINTS = "tracked.conversion_touchpoints"
270
- }
271
- export declare enum ATTRIBUTION_MODEL {
272
- FIRST_CLICK = "first_click",
273
- LAST_CLICK = "last_click",
274
- ANY_CLICK = "any_click"
275
- }
276
- export declare enum PAGES_REPORT_DIMENSION {
277
- LANDING_PAGE = "landing_page",
278
- EXIT_PAGE = "exit_page"
279
- }
1
+ export interface DateRange {
2
+ start: string;
3
+ end: string;
4
+ timezone?: string;
5
+ utcStart?: string;
6
+ utcEnd?: string;
7
+ }
8
+ export declare enum GRANULARITY {
9
+ NONE = "none",
10
+ SECOND = "second",
11
+ MINUTE = "minute",
12
+ HOUR = "hour",
13
+ DAY = "day",
14
+ WEEK = "week",
15
+ MONTH = "month",
16
+ QUARTER = "quarter",
17
+ YEAR = "year"
18
+ }
19
+ export declare enum MEASURE {
20
+ TRACKED_PAGE_VIEWS = "tracked.page_views",
21
+ TRACKED_VIEW_CONTENTS = "tracked.view_contents",
22
+ TRACKED_ADD_TO_CARTS = "tracked.add_to_carts",
23
+ TRACKED_INITIATE_CHECKOUTS = "tracked.initiate_checkouts",
24
+ TRACKED_PURCHASES = "tracked.purchases",
25
+ TRACKED_REVENUE = "tracked.revenue",
26
+ TRACKED_SESSION_CONVERSION_RATE = "tracked.session_conversion_rate",
27
+ TRACKED_REVENUE_PER_VISITOR = "tracked.revenue_per_visitor",
28
+ TRACKED_REVENUE_PER_SESSION = "tracked.revenue_per_session",
29
+ TRACKED_UNIQUE_SESSIONS = "tracked.sessions",
30
+ TRACKED_UNIQUE_VISITORS = "tracked.visitors",
31
+ TRACKED_ADD_TO_CART_RATE = "tracked.add_to_cart_rate",
32
+ TRACKED_VIEW_CONTENT_RATE = "tracked.view_content_rate",
33
+ TRACKED_INITIATE_CHECKOUT_RATE = "tracked.initiate_checkout_rate",
34
+ TRACKED_PV_TO_VC_RATE = "tracked.pv_to_vc_rate",
35
+ TRACKED_VC_TO_ATC_RATE = "tracked.vc_to_atc_rate",
36
+ TRACKED_ATC_TO_IC_RATE = "tracked.atc_to_ic_rate",
37
+ TRACKED_IC_TO_PURCHASE_RATE = "tracked.ic_to_purchase_rate",
38
+ TRACKED_TOTAL_EVENTS = "tracked.events_processed",
39
+ TRACKED_AVG_PAGE_VISITS_PER_SESSION = "tracked.avg_page_visits_per_session",
40
+ TRACKED_AVG_PAGE_VIEWS_PER_SESSION = "tracked.avg_page_views_per_session",
41
+ TRACKED_AVG_VIEW_CONTENTS_PER_SESSION = "tracked.avg_view_contents_per_session",
42
+ TRACKED_AVG_SESSIONS_PER_VISITOR = "tracked.avg_sessions_per_visitor",
43
+ TRACKED_EVENTS = "tracked.events_count",
44
+ TRACKED_EVENTS_VALUE = "tracked.events_value",
45
+ SHOPIFY_CUSTOMERS = "shopify.customers",
46
+ SHOPIFY_ABANDONED_CHECKOUTS_VALUE = "shopify.abandoned_checkouts_value",
47
+ SHOPIFY_ABANDONED_CHECKOUTS = "shopify.abandoned_checkouts",
48
+ SHOPIFY_CANCELLED_ORDERS = "shopify.cancelled_orders_count",
49
+ SHOPIFY_CANCELLED_AMOUNT = "shopify.cancellation_amount",
50
+ SHOPIFY_GROSS_SALES = "shopify.gross_sales",
51
+ SHOPIFY_NET_SALES = "shopify.net_sales",
52
+ SHOPIFY_REFUNDS = "shopify.refunds_count",
53
+ SHOPIFY_REFUND_AMOUNT_REFUND_DATE = "shopify.refunds_amount_refund_date",
54
+ SHOPIFY_REFUND_AMOUNT_ORDER_DATE = "shopify.refunds_amount_order_date",
55
+ SHOPIFY_REFUND_GROSS_PERCENT = "shopify.refunds_gross_percent",
56
+ SHOPIFY_REFUND_NET_PERCENT = "shopify.refunds_net_percent",
57
+ SHOPIFY_REFUND_RATE = "shopify.refunds_rate",
58
+ SHOPIFY_DISCOUNTS = "shopify.discounts_count",
59
+ SHOPIFY_DISCOUNT_AMOUNT = "shopify.discount_amount",
60
+ SHOPIFY_DISCOUNT_GROSS_PERCENT = "shopify.discounts_gross_percent",
61
+ SHOPIFY_DISCOUNT_NET_PERCENT = "shopify.discounts_net_percent",
62
+ SHOPIFY_DISCOUNT_RATE = "shopify.discounts_rate",
63
+ SHOPIFY_REFUND_PLUS_DISCOUNT_AMOUNT = "shopify.refunds_plus_discount",
64
+ SHOPIFY_ORDERS = "shopify.order_count",
65
+ SHOPIFY_AVG_ORDERS_PER_CUSTOMER = "shopify.avg_orders_per_customer",
66
+ SHOPIFY_REVENUE = "shopify.revenue",
67
+ SHOPIFY_SUBTOTAL_AMOUNT = "shopify.subtotal_amount",
68
+ SHOPIFY_TOTAL_AMOUNT = "shopify.total_amount",
69
+ SHOPIFY_NET_PLUS_SHIPPING_AMOUNT = "shopify.net_plus_shipping_amount",
70
+ SHOPIFY_AOV = "shopify.average_order_value",
71
+ SHOPIFY_NET_AOV = "shopify.net_average_order_value",
72
+ SHOPIFY_TOP_PRODUCTS = "shopify.top_products",
73
+ SHOPIFY_PRODUCT_UNITS_SOLD = "shopify.product_units_sold",
74
+ SHOPIFY_CUSTOMER_LTV = "shopify.customer_ltv",
75
+ SHOPIFY_REPEAT_CUSTOMER_RATE = "shopify.repeat_customer_rate",
76
+ SHOPIFY_TAX_AMOUNT = "shopify.tax_amount",
77
+ SHOPIFY_SHIPPING_AMOUNT = "shopify.shipping_amount",
78
+ SHOPIFY_NEW_CUSTOMERS = "shopify.new_customers",
79
+ SHOPIFY_NEW_CUSTOMER_GROSS_SALES = "shopify.new_customer_gross_sales",
80
+ SHOPIFY_NEW_CUSTOMER_GROSS_PERCENT = "shopify.new_customer_gross_percent",
81
+ SHOPIFY_NEW_CUSTOMER_NET_SALES = "shopify.new_customer_net_sales",
82
+ SHOPIFY_NEW_CUSTOMER_AOV = "shopify.new_customer_aov",
83
+ SHOPIFY_NEW_CUSTOMER_NET_AOV = "shopify.new_customer_net_aov",
84
+ SHOPIFY_NEW_CUSTOMER_TOTAL_SALES = "shopify.new_customer_total_sales",
85
+ SHOPIFY_NEW_CUSTOMER_RATE = "shopify.new_customer_rate",
86
+ SHOPIFY_NEW_CUSTOMER_PURCHASES = "shopify.new_customer_purchases",
87
+ SHOPIFY_RETURNING_CUSTOMERS = "shopify.returning_customers",
88
+ SHOPIFY_RETURNING_CUSTOMER_AOV = "shopify.returning_customer_aov",
89
+ SHOPIFY_RETURNING_CUSTOMER_NET_AOV = "shopify.returning_customer_net_aov",
90
+ SHOPIFY_RETURNING_CUSTOMER_RATE = "shopify.returning_customer_rate",
91
+ SHOPIFY_LTV = "shopify.lifetime_value",
92
+ SHOPIFY_LTV_90 = "shopify.lifetime_value_90",
93
+ SHOPIFY_LTV_180 = "shopify.lifetime_value_180",
94
+ SHOPIFY_LTV_365 = "shopify.lifetime_value_365",
95
+ SHOPIFY_LTV_COHORT_GROSS_SALE_PRICE = "shopify.ltv_cohort_gross_sale_price",
96
+ SHOPIFY_LTV_COHORT_NET_SALE_PRICE = "shopify.ltv_cohort_net_sale_price",
97
+ SHOPIFY_LTV_COHORT_NETT_SALE_PRICE = "shopify.ltv_cohort_nett_sale_price",
98
+ SHOPIFY_LTV_COHORT_NETTS_SALE_PRICE = "shopify.ltv_cohort_netts_sale_price",
99
+ SHOPIFY_LTV_COHORT_NETS_SALE_PRICE = "shopify.ltv_cohort_nets_sale_price",
100
+ SHOPIFY_CUSTOMERS_COHORT = "shopify.customers_cohort",
101
+ SHOPIFY_CUSTOMERS_RETENTION_RATE_COHORT = "shopify.customers_retention_rate_cohort",
102
+ SHOPIFY_AVG_ORDER_VALUE_COHORT = "shopify.avg_order_value_cohort",
103
+ SITE_TTFB = "site.ttfb",
104
+ SITE_FCP = "site.fcp",
105
+ SITE_LCP = "site.lcp",
106
+ SITE_TIME_ON_SITE = "site.time_on_site",
107
+ FB_CPC = "fb.cpc",
108
+ FB_CTR = "fb.ctr",
109
+ FB_CPM = "fb.cpm",
110
+ FB_ROAS = "fb.roas",
111
+ FB_SPEND = "fb.spend",
112
+ FB_CPA = "fb.cpa",
113
+ FB_IMPRESSIONS = "fb.impressions",
114
+ FB_CLICKS = "fb.clicks",
115
+ FB_FREQUENCY = "fb.frequency",
116
+ FB_PURCHASES = "fb.purchases",
117
+ FB_PURCHASES_VALUE = "fb.purchase_value",
118
+ FB_NEW_CUSTOMER_PURCHASES = "fb.new_customer_purchases",
119
+ FB_NEW_CUSTOMER_PURCHASES_VALUE = "fb.new_customer_purchases_value",
120
+ FB_NEW_CUSTOMER_CPA = "fb.new_customer_cpa",
121
+ FB_NEW_CUSTOMER_ROAS = "fb.new_customer_roas",
122
+ FB_SPEND_GROSS_PERCENT = "fb.spend_gross_percent",
123
+ FB_SPEND_NET_PERCENT = "fb.spend_net_percent",
124
+ FB_MER_GROSS = "fb.mer_gross",
125
+ FB_MER_NET = "fb.mer_net",
126
+ GOOGLE_CPC = "google.cpc",
127
+ GOOGLE_CTR = "google.ctr",
128
+ GOOGLE_CPM = "google.cpm",
129
+ GOOGLE_ROAS = "google.roas",
130
+ GOOGLE_SPEND = "google.spend",
131
+ GOOGLE_CPA = "google.cpa",
132
+ GOOGLE_IMPRESSIONS = "google.impressions",
133
+ GOOGLE_CLICKS = "google.clicks",
134
+ GOOGLE_FREQUENCY = "google.frequency",
135
+ GOOGLE_PURCHASES = "google.purchases",
136
+ GOOGLE_PURCHASES_VALUE = "google.purchase_value",
137
+ GOOGLE_NEW_CUSTOMER_PURCHASES = "google.new_customer_purchases",
138
+ GOOGLE_NEW_CUSTOMER_PURCHASES_VALUE = "google.new_customer_purchases_value",
139
+ GOOGLE_NEW_CUSTOMER_CPA = "google.new_customer_cpa",
140
+ GOOGLE_NEW_CUSTOMER_ROAS = "google.new_customer_roas",
141
+ GOOGLE_SPEND_GROSS_PERCENT = "google.spend_gross_percent",
142
+ GOOGLE_SPEND_NET_PERCENT = "google.spend_net_percent",
143
+ GOOGLE_MER_GROSS = "google.mer_gross",
144
+ GOOGLE_MER_NET = "google.mer_net",
145
+ BLENDED_CPC = "blended.cpc",
146
+ BLENDED_CTR = "blended.ctr",
147
+ BLENDED_CPM = "blended.cpm",
148
+ BLENDED_ROAS = "blended.roas",
149
+ BLENDED_AD_SPEND = "blended.ad_spend",
150
+ BLENDED_CPA = "blended.cpa",
151
+ BLENDED_IMPRESSIONS = "blended.impressions",
152
+ BLENDED_CLICKS = "blended.clicks",
153
+ BLENDED_FREQUENCY = "blended.frequency",
154
+ BLENDED_PURCHASES = "blended.purchases",
155
+ BLENDED_PURCHASES_VALUE = "blended.purchases_value",
156
+ BLENDED_NEW_CUSTOMER_PURCHASES = "blended.new_customer_purchases",
157
+ BLENDED_NEW_CUSTOMER_PURCHASES_VALUE = "blended.new_customer_purchases_value",
158
+ BLENDED_NEW_CUSTOMER_CPA = "blended.new_customer_cpa",
159
+ BLENDED_NEW_CUSTOMER_ROAS = "blended.new_customer_roas",
160
+ BLENDED_SPEND_GROSS_PERCENT = "blended.spend_gross_percent",
161
+ BLENDED_SPEND_NET_PERCENT = "blended.spend_net_percent",
162
+ BLENDED_MER_GROSS = "blended.mer_gross",
163
+ BLENDED_MER_NET = "blended.mer_net",
164
+ CORE_CPA = "core.cpa",
165
+ CORE_NEW_CUSTOMER_CPA = "core.new_customer_cpa",
166
+ CORE_ROAS = "core.roas",
167
+ CORE_NEW_CUSTOMER_ROAS = "core.new_customer_roas",
168
+ CORE_RRADD = "core.rradd",
169
+ CORE_RRADD_GROSS_PERCENT = "core.rradd_gross_percent"
170
+ }
171
+ export interface Query {
172
+ pixelId: string;
173
+ measures: MeasureConfig[];
174
+ dateRange: DateRange;
175
+ compareDateRange?: DateRange;
176
+ granularity?: GRANULARITY;
177
+ dimensions?: DIMENSION[];
178
+ filters?: any[];
179
+ timezone?: string;
180
+ orderSettings?: OrderSettings;
181
+ }
182
+ export interface MeasureConfig {
183
+ measure: MEASURE;
184
+ pacing?: boolean;
185
+ }
186
+ export interface OrderSettings {
187
+ countVoidedOrders?: boolean;
188
+ countPendingOrders?: boolean;
189
+ }
190
+ export interface AppliedDimensions {
191
+ dimensionName?: string;
192
+ dimensionValue?: string;
193
+ }
194
+ export declare type MeasureDataRow = {
195
+ [key: string]: any;
196
+ dt?: string;
197
+ start?: string;
198
+ end?: string;
199
+ };
200
+ export interface QueryData {
201
+ primary?: MeasureDataRow[];
202
+ compare?: MeasureDataRow[];
203
+ }
204
+ export interface MeasureDetail {
205
+ measure: MEASURE;
206
+ isAverage: boolean;
207
+ isPercentage: boolean;
208
+ calculatedAverage: boolean;
209
+ success: boolean;
210
+ primaryAvg: number;
211
+ compareAvg: number;
212
+ primarySum: number;
213
+ compareSum: number;
214
+ percentDiff: number;
215
+ hasPacing: boolean;
216
+ }
217
+ export interface QueryResult {
218
+ granularity: GRANULARITY;
219
+ dimensions: DIMENSION[];
220
+ dateRange: DateRange;
221
+ compareDateRange?: DateRange;
222
+ measureDetails: MeasureDetail[] | null;
223
+ data: QueryData | null;
224
+ }
225
+ export interface QueryResponse {
226
+ results: QueryResult[];
227
+ }
228
+ export declare enum DIMENSION {
229
+ DEVICE_MODEL = "device_model",
230
+ DEVICE_VENDOR = "device_vendor",
231
+ DEVICE_TYPE = "device_type",
232
+ BROWSER = "browser",
233
+ BROWSER_VERSION = "browser_version",
234
+ BROWSER_OS = "browser_os",
235
+ OS = "OS",
236
+ LANDING_PATH = "landing_path",
237
+ PAGE_PATH = "path",
238
+ PAGE_TITLE = "title",
239
+ QUERY_STRING = "query",
240
+ GATEWAY = "gateway",
241
+ CURRENCY = "currency",
242
+ SHIPPING_CODE = "shipping_code",
243
+ IS_MOBILE = "is_mobile",
244
+ IS_WIRELESS = "is_wireless",
245
+ CITY = "city",
246
+ PROVINCE_CODE = "province_code",
247
+ PROVINCE = "province",
248
+ COUNTRY_CODE = "country_code",
249
+ COUNTRY = "country",
250
+ POSTAL_CODE = "postal_code",
251
+ FINANCIAL_STATUS = "financial_status",
252
+ FULFILLMENT_STATUS = "fulfillment_status",
253
+ DISCOUNT_CODE = "discount_code",
254
+ REFERRER = "referrer",
255
+ REFERRER_MEDIUM = "referrer_medium",
256
+ REFERRER_SOURCE = "referrer_source",
257
+ REFERRER_TERM = "referrer_term",
258
+ UTM_SOURCE = "utm_source",
259
+ UTM_CAMPAIGN = "utm_campaign",
260
+ UTM_MEDIUM = "utm_medium",
261
+ UTM_TERM = "utm_term",
262
+ UTM_CONTENT = "utm_content",
263
+ UTM_SOURCE_MEDIUM = "utm_source_medium",
264
+ UTM_SOURCE_CAMPAIGN = "utm_source_campaign",
265
+ UTM_ADSET = "utm_adset",
266
+ UTM_AD = "utm_ad",
267
+ CLICK_NETWORK = "click_network",
268
+ ADBLOCK_DETECTED = "adblock_detected",
269
+ TIMEZONE = "timezone",
270
+ LOCALE = "locale",
271
+ CAMPAIGN = "campaign",
272
+ ADSET = "adset",
273
+ AD = "ad",
274
+ CUSTOMER_TYPE = "customer_type",
275
+ AD_SOURCE = "ad_source",
276
+ PRODUCT = "product",
277
+ VARIANT = "variant",
278
+ ORDER = "order",
279
+ NEW_CUSTOMER_ORDER = "new_customer_order"
280
+ }
281
+ export declare enum FIELDS {
282
+ SHOPIFY_ORDER_ID = "shopify.order_id",
283
+ SHOPIFY_ORDER_NAME = "shopify.order_name",
284
+ SHOPIFY_ORDER_CREATED_DATE = "shopify.order_created_date",
285
+ SHOPIFY_ORDER_IS_NEW_CUSTOMER = "shopify.order_is_new_customer",
286
+ SHOPIFY_ORDER_CUSTOMER_EMAIL = "shopify.order_customer_email",
287
+ SHOPIFY_ORDER_CUSTOMER_PHONE = "shopify.order_customer_phone",
288
+ TRACKED_CONVERSION_TOUCHPOINTS = "tracked.conversion_touchpoints"
289
+ }
290
+ export declare enum ATTRIBUTION_MODEL {
291
+ FIRST_CLICK = "first_click",
292
+ LAST_CLICK = "last_click",
293
+ ANY_CLICK = "any_click"
294
+ }
295
+ export declare enum PAGES_REPORT_DIMENSION {
296
+ LANDING_PAGE = "landing_page",
297
+ EXIT_PAGE = "exit_page"
298
+ }