@adtrackify/at-tracking-event-types 3.1.12 → 3.1.13

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 (157) 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 +292 -292
  30. package/dist/cjs/types/api/query.js +241 -241
  31. package/dist/cjs/types/api/shopify-app-install.d.ts +39 -39
  32. package/dist/cjs/types/api/shopify-app-install.js +14 -14
  33. package/dist/cjs/types/api/subscription.d.ts +155 -155
  34. package/dist/cjs/types/api/subscription.js +47 -47
  35. package/dist/cjs/types/api/tracking-events.d.ts +15 -15
  36. package/dist/cjs/types/api/tracking-events.js +2 -2
  37. package/dist/cjs/types/api/user.d.ts +13 -13
  38. package/dist/cjs/types/api/user.js +2 -2
  39. package/dist/cjs/types/common/address.d.ts +15 -15
  40. package/dist/cjs/types/common/address.js +2 -2
  41. package/dist/cjs/types/common/currency.d.ts +1 -1
  42. package/dist/cjs/types/common/currency.js +63 -63
  43. package/dist/cjs/types/common/index.d.ts +2 -2
  44. package/dist/cjs/types/common/index.js +18 -18
  45. package/dist/cjs/types/event/base/event-name-enum.d.ts +58 -58
  46. package/dist/cjs/types/event/base/event-name-enum.js +64 -64
  47. package/dist/cjs/types/event/base/event.d.ts +20 -20
  48. package/dist/cjs/types/event/base/event.js +10 -10
  49. package/dist/cjs/types/event/base/index.d.ts +2 -2
  50. package/dist/cjs/types/event/base/index.js +18 -18
  51. package/dist/cjs/types/event/context/event-context-identity.d.ts +21 -21
  52. package/dist/cjs/types/event/context/event-context-identity.js +2 -2
  53. package/dist/cjs/types/event/context/event-context.d.ts +188 -187
  54. package/dist/cjs/types/event/context/event-context.js +2 -2
  55. package/dist/cjs/types/event/context/index.d.ts +2 -2
  56. package/dist/cjs/types/event/context/index.js +18 -18
  57. package/dist/cjs/types/event/index.d.ts +5 -5
  58. package/dist/cjs/types/event/index.js +21 -21
  59. package/dist/cjs/types/event/log-event.d.ts +35 -35
  60. package/dist/cjs/types/event/log-event.js +22 -22
  61. package/dist/cjs/types/event/metric-event.d.ts +13 -13
  62. package/dist/cjs/types/event/metric-event.js +2 -2
  63. package/dist/cjs/types/event/tracking-event.d.ts +62 -62
  64. package/dist/cjs/types/event/tracking-event.js +2 -2
  65. package/dist/cjs/types/event-bus-event.d.ts +25 -25
  66. package/dist/cjs/types/event-bus-event.js +2 -2
  67. package/dist/cjs/types/fingerprint/browser-attributes.d.ts +60 -60
  68. package/dist/cjs/types/fingerprint/browser-attributes.js +2 -2
  69. package/dist/cjs/types/fingerprint/index.d.ts +6 -6
  70. package/dist/cjs/types/fingerprint/index.js +18 -18
  71. package/dist/cjs/types/fingerprint/server-attributes.d.ts +50 -50
  72. package/dist/cjs/types/fingerprint/server-attributes.js +2 -2
  73. package/dist/cjs/types/index.d.ts +7 -7
  74. package/dist/cjs/types/index.js +23 -23
  75. package/dist/cjs/types/third-party-event-configuration-types.d.ts +10 -10
  76. package/dist/cjs/types/third-party-event-configuration-types.js +2 -2
  77. package/dist/cjs/types/tracking-event-ingest-message.d.ts +10 -10
  78. package/dist/cjs/types/tracking-event-ingest-message.js +2 -2
  79. package/dist/esm/index.d.ts +1 -1
  80. package/dist/esm/index.js +1 -1
  81. package/dist/esm/types/api/account.d.ts +62 -62
  82. package/dist/esm/types/api/account.js +20 -20
  83. package/dist/esm/types/api/contact-acquisition.d.ts +39 -39
  84. package/dist/esm/types/api/contact-acquisition.js +13 -13
  85. package/dist/esm/types/api/destination-tracked-events.d.ts +11 -11
  86. package/dist/esm/types/api/destination-tracked-events.js +1 -1
  87. package/dist/esm/types/api/destinations/destination-catalog.d.ts +30 -30
  88. package/dist/esm/types/api/destinations/destination-catalog.js +1 -1
  89. package/dist/esm/types/api/destinations/destinations.d.ts +93 -93
  90. package/dist/esm/types/api/destinations/destinations.js +40 -40
  91. package/dist/esm/types/api/destinations/third-party-contact-acquisition-configs.d.ts +9 -9
  92. package/dist/esm/types/api/destinations/third-party-contact-acquisition-configs.js +1 -1
  93. package/dist/esm/types/api/destinations/third-party-destination-configs.d.ts +109 -109
  94. package/dist/esm/types/api/destinations/third-party-destination-configs.js +6 -6
  95. package/dist/esm/types/api/destinations/third-party-integration-configs.d.ts +41 -41
  96. package/dist/esm/types/api/destinations/third-party-integration-configs.js +8 -8
  97. package/dist/esm/types/api/event-last-seen.d.ts +6 -6
  98. package/dist/esm/types/api/event-last-seen.js +1 -1
  99. package/dist/esm/types/api/event-status.d.ts +18 -18
  100. package/dist/esm/types/api/event-status.js +6 -6
  101. package/dist/esm/types/api/index.d.ts +17 -17
  102. package/dist/esm/types/api/index.js +17 -17
  103. package/dist/esm/types/api/log-events.d.ts +22 -22
  104. package/dist/esm/types/api/log-events.js +1 -1
  105. package/dist/esm/types/api/pixel-setup-health.d.ts +19 -19
  106. package/dist/esm/types/api/pixel-setup-health.js +1 -1
  107. package/dist/esm/types/api/query.d.ts +292 -292
  108. package/dist/esm/types/api/query.js +238 -238
  109. package/dist/esm/types/api/shopify-app-install.d.ts +39 -39
  110. package/dist/esm/types/api/shopify-app-install.js +11 -11
  111. package/dist/esm/types/api/subscription.d.ts +155 -155
  112. package/dist/esm/types/api/subscription.js +44 -44
  113. package/dist/esm/types/api/tracking-events.d.ts +15 -15
  114. package/dist/esm/types/api/tracking-events.js +1 -1
  115. package/dist/esm/types/api/user.d.ts +13 -13
  116. package/dist/esm/types/api/user.js +1 -1
  117. package/dist/esm/types/common/address.d.ts +15 -15
  118. package/dist/esm/types/common/address.js +1 -1
  119. package/dist/esm/types/common/currency.d.ts +1 -1
  120. package/dist/esm/types/common/currency.js +60 -60
  121. package/dist/esm/types/common/index.d.ts +2 -2
  122. package/dist/esm/types/common/index.js +2 -2
  123. package/dist/esm/types/event/base/event-name-enum.d.ts +58 -58
  124. package/dist/esm/types/event/base/event-name-enum.js +61 -61
  125. package/dist/esm/types/event/base/event.d.ts +20 -20
  126. package/dist/esm/types/event/base/event.js +7 -7
  127. package/dist/esm/types/event/base/index.d.ts +2 -2
  128. package/dist/esm/types/event/base/index.js +2 -2
  129. package/dist/esm/types/event/context/event-context-identity.d.ts +21 -21
  130. package/dist/esm/types/event/context/event-context-identity.js +1 -1
  131. package/dist/esm/types/event/context/event-context.d.ts +188 -187
  132. package/dist/esm/types/event/context/event-context.js +1 -1
  133. package/dist/esm/types/event/context/index.d.ts +2 -2
  134. package/dist/esm/types/event/context/index.js +2 -2
  135. package/dist/esm/types/event/index.d.ts +5 -5
  136. package/dist/esm/types/event/index.js +5 -5
  137. package/dist/esm/types/event/log-event.d.ts +35 -35
  138. package/dist/esm/types/event/log-event.js +19 -19
  139. package/dist/esm/types/event/metric-event.d.ts +13 -13
  140. package/dist/esm/types/event/metric-event.js +1 -1
  141. package/dist/esm/types/event/tracking-event.d.ts +62 -62
  142. package/dist/esm/types/event/tracking-event.js +1 -1
  143. package/dist/esm/types/event-bus-event.d.ts +25 -25
  144. package/dist/esm/types/event-bus-event.js +1 -1
  145. package/dist/esm/types/fingerprint/browser-attributes.d.ts +60 -60
  146. package/dist/esm/types/fingerprint/browser-attributes.js +1 -1
  147. package/dist/esm/types/fingerprint/index.d.ts +6 -6
  148. package/dist/esm/types/fingerprint/index.js +2 -2
  149. package/dist/esm/types/fingerprint/server-attributes.d.ts +50 -50
  150. package/dist/esm/types/fingerprint/server-attributes.js +1 -1
  151. package/dist/esm/types/index.d.ts +7 -7
  152. package/dist/esm/types/index.js +7 -7
  153. package/dist/esm/types/third-party-event-configuration-types.d.ts +10 -10
  154. package/dist/esm/types/third-party-event-configuration-types.js +1 -1
  155. package/dist/esm/types/tracking-event-ingest-message.d.ts +10 -10
  156. package/dist/esm/types/tracking-event-ingest-message.js +1 -1
  157. package/package.json +1 -1
@@ -1,292 +1,292 @@
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_PRODUCT_UNITS_SOLD = "shopify.product_units_sold",
68
- SHOPIFY_CUSTOMER_LTV = "shopify.customer_ltv",
69
- SHOPIFY_REPEAT_CUSTOMER_RATE = "shopify.repeat_customer_rate",
70
- SHOPIFY_TAX_AMOUNT = "shopify.tax_amount",
71
- SHOPIFY_SHIPPING_AMOUNT = "shopify.shipping_amount",
72
- SHOPIFY_NEW_CUSTOMERS = "shopify.new_customers",
73
- SHOPIFY_NEW_CUSTOMER_GROSS = "shopify.new_customer_gross",
74
- SHOPIFY_NEW_CUSTOMER_GROSS_PERCENT = "shopify.new_customer_gross_percent",
75
- SHOPIFY_NEW_CUSTOMER_NET = "shopify.new_customer_net",
76
- SHOPIFY_NEW_CUSTOMER_AOV = "shopify.new_customer_aov",
77
- SHOPIFY_NEW_CUSTOMER_NET_AOV = "shopify.new_customer_net_aov",
78
- SHOPIFY_NEW_CUSTOMER_RATE = "shopify.new_customer_rate",
79
- SHOPIFY_NEW_CUSTOMER_PURCHASES = "shopify.new_customer_purchases",
80
- SHOPIFY_RETURNING_CUSTOMERS = "shopify.returning_customers",
81
- SHOPIFY_RETURNING_CUSTOMER_AOV = "shopify.returning_customer_aov",
82
- SHOPIFY_RETURNING_CUSTOMER_NET_AOV = "shopify.returning_customer_net_aov",
83
- SHOPIFY_RETURNING_CUSTOMER_RATE = "shopify.returning_customer_rate",
84
- SHOPIFY_LTV = "shopify.lifetime_value",
85
- SHOPIFY_LTV_90 = "shopify.lifetime_value_90",
86
- SHOPIFY_LTV_180 = "shopify.lifetime_value_180",
87
- SHOPIFY_LTV_365 = "shopify.lifetime_value_365",
88
- SHOPIFY_LTV_COHORT_GROSS_SALE_PRICE = "shopify.ltv_cohort_gross_sale_price",
89
- SHOPIFY_LTV_COHORT_NET_SALE_PRICE = "shopify.ltv_cohort_net_sale_price",
90
- SHOPIFY_LTV_COHORT_NETT_SALE_PRICE = "shopify.ltv_cohort_nett_sale_price",
91
- SHOPIFY_LTV_COHORT_NETTS_SALE_PRICE = "shopify.ltv_cohort_netts_sale_price",
92
- SHOPIFY_LTV_COHORT_NETS_SALE_PRICE = "shopify.ltv_cohort_nets_sale_price",
93
- SHOPIFY_CUSTOMERS_COHORT = "shopify.customers_cohort",
94
- SHOPIFY_CUSTOMERS_RETENTION_RATE_COHORT = "shopify.customers_retention_rate_cohort",
95
- SHOPIFY_AVG_ORDER_VALUE_COHORT = "shopify.avg_order_value_cohort",
96
- SITE_TTFB = "site.ttfb",
97
- SITE_FCP = "site.fcp",
98
- SITE_LCP = "site.lcp",
99
- SITE_TIME_ON_SITE = "site.time_on_site",
100
- FB_CPC = "fb.cpc",
101
- FB_CTR = "fb.ctr",
102
- FB_CPM = "fb.cpm",
103
- FB_ROAS = "fb.roas",
104
- FB_SPEND = "fb.spend",
105
- FB_CPA = "fb.cpa",
106
- FB_IMPRESSIONS = "fb.impressions",
107
- FB_CLICKS = "fb.clicks",
108
- FB_PURCHASES = "fb.purchases",
109
- FB_PURCHASE_REVENUE = "fb.purchase_revenue",
110
- FB_NEW_CUSTOMER_CPA = "fb.new_customer_cpa",
111
- FB_NEW_CUSTOMER_ROAS = "fb.new_customer_roas",
112
- FB_SPEND_GROSS_PERCENT = "fb.spend_gross_percent",
113
- FB_SPEND_NET_PERCENT = "fb.spend_net_percent",
114
- FB_MER_GROSS = "fb.mer_gross",
115
- FB_MER_NET = "fb.mer_net",
116
- CPC = "cpc",
117
- CTR = "ctr",
118
- CPM = "cpm",
119
- ROAS = "roas",
120
- AD_SPEND = "ad_spend",
121
- CPA = "cpa",
122
- IMPRESSIONS = "impressions",
123
- CLICKS = "clicks",
124
- PURCHASES = "purchases",
125
- PURCHASE_REVENUE = "purchase_revenue",
126
- NEW_CUSTOMER_CPA = "new_customer_cpa",
127
- NEW_CUSTOMER_ROAS = "new_customer_roas",
128
- SPEND_GROSS_PERCENT = "spend_gross_percent",
129
- SPEND_NET_PERCENT = "spend_net_percent",
130
- MER_GROSS = "mer_gross",
131
- MER_NET = "mer_net",
132
- RRADD = "rradd",
133
- RRADD_GROSS_PERCENT = "rradd_gross_percent"
134
- }
135
- export interface Query {
136
- pixelId: string;
137
- measures: MeasureConfig[];
138
- dateRange: DateRange;
139
- compareDateRange?: DateRange;
140
- granularity?: GRANULARITY;
141
- dimensions?: DIMENSION[];
142
- filters?: any[];
143
- timezone?: string;
144
- orderSettings?: OrderSettings;
145
- }
146
- export interface MeasureConfig {
147
- measure: MEASURE;
148
- pacing?: boolean;
149
- }
150
- export interface OrderSettings {
151
- countVoidedOrders?: boolean;
152
- countPendingOrders?: boolean;
153
- }
154
- export interface AppliedDimensions {
155
- dimensionName?: string;
156
- dimensionValue?: string;
157
- }
158
- export declare type MeasureDataRow = {
159
- [key: string]: any;
160
- dt?: string;
161
- start?: string;
162
- end?: string;
163
- };
164
- export interface QueryData {
165
- primary?: MeasureDataRow[];
166
- compare?: MeasureDataRow[];
167
- }
168
- export interface MeasureDetail {
169
- measure: MEASURE;
170
- isAverage: boolean;
171
- isPercentage: boolean;
172
- calculatedAverage: boolean;
173
- success: boolean;
174
- primaryAvg: number;
175
- compareAvg: number;
176
- primarySum: number;
177
- compareSum: number;
178
- percentDiff: number;
179
- hasPacing: boolean;
180
- }
181
- export interface QueryResult {
182
- granularity: GRANULARITY;
183
- dimensions: DIMENSION[];
184
- dateRange: DateRange;
185
- compareDateRange?: DateRange;
186
- measureDetails: MeasureDetail[] | null;
187
- data: QueryData | null;
188
- }
189
- export interface QueryResponse {
190
- results: QueryResult[];
191
- }
192
- export declare enum DIMENSION {
193
- DEVICE_MODEL = "device_model",
194
- DEVICE_VENDOR = "device_vendor",
195
- DEVICE_TYPE = "device_type",
196
- BROWSER = "browser",
197
- BROWSER_VERSION = "browser_version",
198
- BROWSER_OS = "browser_os",
199
- OS = "OS",
200
- LANDING_PATH = "landing_path",
201
- PAGE_PATH = "path",
202
- PAGE_TITLE = "title",
203
- QUERY_STRING = "query",
204
- GATEWAY = "gateway",
205
- CURRENCY = "currency",
206
- SHIPPING_CODE = "shipping_code",
207
- IS_MOBILE = "is_mobile",
208
- IS_WIRELESS = "is_wireless",
209
- CITY = "city",
210
- PROVINCE_CODE = "province_code",
211
- PROVINCE = "province",
212
- COUNTRY_CODE = "country_code",
213
- COUNTRY = "country",
214
- POSTAL_CODE = "postal_code",
215
- FINANCIAL_STATUS = "financial_status",
216
- FULFILLMENT_STATUS = "fulfillment_status",
217
- DISCOUNT_CODE = "discount_code",
218
- REFERRER = "referrer",
219
- REFERRER_MEDIUM = "referrer_medium",
220
- REFERRER_SOURCE = "referrer_source",
221
- REFERRER_TERM = "referrer_term",
222
- UTM_CAMPAIGN = "utm_campaign",
223
- UTM_SOURCE = "utm_source",
224
- UTM_MEDIUM = "utm_medium",
225
- UTM_TERM = "utm_term",
226
- UTM_CONTENT = "utm_content",
227
- CLICK_NETWORK = "click_network",
228
- ADBLOCK_DETECTED = "adblock_detected",
229
- TIMEZONE = "timezone",
230
- LOCALE = "locale",
231
- CAMPAIGN = "campaign",
232
- ADSET = "adset",
233
- AD = "ad",
234
- CUSTOMER_TYPE = "customer_type",
235
- AD_SOURCE = "ad_source",
236
- PRODUCT = "product",
237
- VARIANT = "variant"
238
- }
239
- export declare enum ATTRIBUTION_MEASURE {
240
- PURCHASES = "purchases",
241
- PURCHASES_NET_REVENUE = "purchases_net_revenue",
242
- PURCHASES_GROSS_REVENUE = "purchases_gross_revenue",
243
- PURCHASES_TOTAL_REVENUE = "purchases_total_revenue",
244
- GROSS_AOV = "gross_average_order_value",
245
- NET_AOV = "net_average_order_value",
246
- NEW_CUSTOMERS = "new_customers",
247
- NEW_CUSTOMER_PURCHASES = "new_customer_purchases",
248
- NEW_CUSTOMER_PURCHASES_NET_REVENUE = "new_customer_purchases_net_revenue",
249
- NEW_CUSTOMER_PURCHASES_GROSS_REVENUE = "new_customer_purchases_gross_revenue",
250
- NEW_CUSTOMER_PURCHASES_TOTAL_REVENUE = "new_customer_purchases_total_revenue",
251
- NEW_CUSTOMER_PURCHASES_GROSS_AOV = "new_customer_purchases_gross_aov",
252
- NEW_CUSTOMER_PURCHASES_NET_AOV = "new_customer_purchases_net_aov",
253
- NEW_CUSTOMER_PERCENT = "new_customer_percent",
254
- RETURNING_CUSTOMER_PERCENT = "returning_customer_percent",
255
- CPA = "cpa",
256
- NEW_CUSTOMER_CPA = "new_customer_cpa",
257
- ROAS = "roas",
258
- NEW_CUSTOMER_ROAS = "new_customer_roas",
259
- FB_SPEND = "fb_spend",
260
- FB_ROAS = "fb_roas",
261
- ORDER_ID = "order_id",
262
- ORDER_NAME = "orderName",
263
- ORDER_CREATED_DATE = "order_created_date",
264
- ORDER_IS_NEW_CUSTOMER = "order_is_new_customer",
265
- ORDER_GROSS_SALE_PRICE = "order_gross_sale_price",
266
- ORDER_NET_SALE_PRICE = "order_net_sale_price",
267
- ORDER_CUSTOMER_EMAIL = "order_customer_email",
268
- ORDER_CUSTOMER_PHONE = "order_customer_phone",
269
- ORDER_SOURCE_TOUCHPOINTS = "order_source_touchpoints"
270
- }
271
- export declare enum ATTRIBUTION_DIMENSION {
272
- SOURCE = "source",
273
- MEDIUM = "medium",
274
- CAMPAIGN = "campaign",
275
- TERM = "term",
276
- CONTENT = "content",
277
- SOURCE_MEDIUM = "source_medium",
278
- SOURCE_CAMPAIGN = "source_campaign",
279
- AD_SET = "ad_set",
280
- AD = "ad",
281
- ORDER = "order",
282
- NEW_CUSTOMER_ORDER = "new_customer_order"
283
- }
284
- export declare enum ATTRIBUTION_MODEL {
285
- FIRST_CLICK = "first_click",
286
- LAST_CLICK = "last_click",
287
- ANY_CLICK = "any_click"
288
- }
289
- export declare enum PAGES_REPORT_DIMENSION {
290
- LANDING_PAGE = "landing_page",
291
- EXIT_PAGE = "exit_page"
292
- }
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_PRODUCT_UNITS_SOLD = "shopify.product_units_sold",
68
+ SHOPIFY_CUSTOMER_LTV = "shopify.customer_ltv",
69
+ SHOPIFY_REPEAT_CUSTOMER_RATE = "shopify.repeat_customer_rate",
70
+ SHOPIFY_TAX_AMOUNT = "shopify.tax_amount",
71
+ SHOPIFY_SHIPPING_AMOUNT = "shopify.shipping_amount",
72
+ SHOPIFY_NEW_CUSTOMERS = "shopify.new_customers",
73
+ SHOPIFY_NEW_CUSTOMER_GROSS = "shopify.new_customer_gross",
74
+ SHOPIFY_NEW_CUSTOMER_GROSS_PERCENT = "shopify.new_customer_gross_percent",
75
+ SHOPIFY_NEW_CUSTOMER_NET = "shopify.new_customer_net",
76
+ SHOPIFY_NEW_CUSTOMER_AOV = "shopify.new_customer_aov",
77
+ SHOPIFY_NEW_CUSTOMER_NET_AOV = "shopify.new_customer_net_aov",
78
+ SHOPIFY_NEW_CUSTOMER_RATE = "shopify.new_customer_rate",
79
+ SHOPIFY_NEW_CUSTOMER_PURCHASES = "shopify.new_customer_purchases",
80
+ SHOPIFY_RETURNING_CUSTOMERS = "shopify.returning_customers",
81
+ SHOPIFY_RETURNING_CUSTOMER_AOV = "shopify.returning_customer_aov",
82
+ SHOPIFY_RETURNING_CUSTOMER_NET_AOV = "shopify.returning_customer_net_aov",
83
+ SHOPIFY_RETURNING_CUSTOMER_RATE = "shopify.returning_customer_rate",
84
+ SHOPIFY_LTV = "shopify.lifetime_value",
85
+ SHOPIFY_LTV_90 = "shopify.lifetime_value_90",
86
+ SHOPIFY_LTV_180 = "shopify.lifetime_value_180",
87
+ SHOPIFY_LTV_365 = "shopify.lifetime_value_365",
88
+ SHOPIFY_LTV_COHORT_GROSS_SALE_PRICE = "shopify.ltv_cohort_gross_sale_price",
89
+ SHOPIFY_LTV_COHORT_NET_SALE_PRICE = "shopify.ltv_cohort_net_sale_price",
90
+ SHOPIFY_LTV_COHORT_NETT_SALE_PRICE = "shopify.ltv_cohort_nett_sale_price",
91
+ SHOPIFY_LTV_COHORT_NETTS_SALE_PRICE = "shopify.ltv_cohort_netts_sale_price",
92
+ SHOPIFY_LTV_COHORT_NETS_SALE_PRICE = "shopify.ltv_cohort_nets_sale_price",
93
+ SHOPIFY_CUSTOMERS_COHORT = "shopify.customers_cohort",
94
+ SHOPIFY_CUSTOMERS_RETENTION_RATE_COHORT = "shopify.customers_retention_rate_cohort",
95
+ SHOPIFY_AVG_ORDER_VALUE_COHORT = "shopify.avg_order_value_cohort",
96
+ SITE_TTFB = "site.ttfb",
97
+ SITE_FCP = "site.fcp",
98
+ SITE_LCP = "site.lcp",
99
+ SITE_TIME_ON_SITE = "site.time_on_site",
100
+ FB_CPC = "fb.cpc",
101
+ FB_CTR = "fb.ctr",
102
+ FB_CPM = "fb.cpm",
103
+ FB_ROAS = "fb.roas",
104
+ FB_SPEND = "fb.spend",
105
+ FB_CPA = "fb.cpa",
106
+ FB_IMPRESSIONS = "fb.impressions",
107
+ FB_CLICKS = "fb.clicks",
108
+ FB_PURCHASES = "fb.purchases",
109
+ FB_PURCHASE_REVENUE = "fb.purchase_revenue",
110
+ FB_NEW_CUSTOMER_CPA = "fb.new_customer_cpa",
111
+ FB_NEW_CUSTOMER_ROAS = "fb.new_customer_roas",
112
+ FB_SPEND_GROSS_PERCENT = "fb.spend_gross_percent",
113
+ FB_SPEND_NET_PERCENT = "fb.spend_net_percent",
114
+ FB_MER_GROSS = "fb.mer_gross",
115
+ FB_MER_NET = "fb.mer_net",
116
+ CPC = "cpc",
117
+ CTR = "ctr",
118
+ CPM = "cpm",
119
+ ROAS = "roas",
120
+ AD_SPEND = "ad_spend",
121
+ CPA = "cpa",
122
+ IMPRESSIONS = "impressions",
123
+ CLICKS = "clicks",
124
+ PURCHASES = "purchases",
125
+ PURCHASE_REVENUE = "purchase_revenue",
126
+ NEW_CUSTOMER_CPA = "new_customer_cpa",
127
+ NEW_CUSTOMER_ROAS = "new_customer_roas",
128
+ SPEND_GROSS_PERCENT = "spend_gross_percent",
129
+ SPEND_NET_PERCENT = "spend_net_percent",
130
+ MER_GROSS = "mer_gross",
131
+ MER_NET = "mer_net",
132
+ RRADD = "rradd",
133
+ RRADD_GROSS_PERCENT = "rradd_gross_percent"
134
+ }
135
+ export interface Query {
136
+ pixelId: string;
137
+ measures: MeasureConfig[];
138
+ dateRange: DateRange;
139
+ compareDateRange?: DateRange;
140
+ granularity?: GRANULARITY;
141
+ dimensions?: DIMENSION[];
142
+ filters?: any[];
143
+ timezone?: string;
144
+ orderSettings?: OrderSettings;
145
+ }
146
+ export interface MeasureConfig {
147
+ measure: MEASURE;
148
+ pacing?: boolean;
149
+ }
150
+ export interface OrderSettings {
151
+ countVoidedOrders?: boolean;
152
+ countPendingOrders?: boolean;
153
+ }
154
+ export interface AppliedDimensions {
155
+ dimensionName?: string;
156
+ dimensionValue?: string;
157
+ }
158
+ export declare type MeasureDataRow = {
159
+ [key: string]: any;
160
+ dt?: string;
161
+ start?: string;
162
+ end?: string;
163
+ };
164
+ export interface QueryData {
165
+ primary?: MeasureDataRow[];
166
+ compare?: MeasureDataRow[];
167
+ }
168
+ export interface MeasureDetail {
169
+ measure: MEASURE;
170
+ isAverage: boolean;
171
+ isPercentage: boolean;
172
+ calculatedAverage: boolean;
173
+ success: boolean;
174
+ primaryAvg: number;
175
+ compareAvg: number;
176
+ primarySum: number;
177
+ compareSum: number;
178
+ percentDiff: number;
179
+ hasPacing: boolean;
180
+ }
181
+ export interface QueryResult {
182
+ granularity: GRANULARITY;
183
+ dimensions: DIMENSION[];
184
+ dateRange: DateRange;
185
+ compareDateRange?: DateRange;
186
+ measureDetails: MeasureDetail[] | null;
187
+ data: QueryData | null;
188
+ }
189
+ export interface QueryResponse {
190
+ results: QueryResult[];
191
+ }
192
+ export declare enum DIMENSION {
193
+ DEVICE_MODEL = "device_model",
194
+ DEVICE_VENDOR = "device_vendor",
195
+ DEVICE_TYPE = "device_type",
196
+ BROWSER = "browser",
197
+ BROWSER_VERSION = "browser_version",
198
+ BROWSER_OS = "browser_os",
199
+ OS = "OS",
200
+ LANDING_PATH = "landing_path",
201
+ PAGE_PATH = "path",
202
+ PAGE_TITLE = "title",
203
+ QUERY_STRING = "query",
204
+ GATEWAY = "gateway",
205
+ CURRENCY = "currency",
206
+ SHIPPING_CODE = "shipping_code",
207
+ IS_MOBILE = "is_mobile",
208
+ IS_WIRELESS = "is_wireless",
209
+ CITY = "city",
210
+ PROVINCE_CODE = "province_code",
211
+ PROVINCE = "province",
212
+ COUNTRY_CODE = "country_code",
213
+ COUNTRY = "country",
214
+ POSTAL_CODE = "postal_code",
215
+ FINANCIAL_STATUS = "financial_status",
216
+ FULFILLMENT_STATUS = "fulfillment_status",
217
+ DISCOUNT_CODE = "discount_code",
218
+ REFERRER = "referrer",
219
+ REFERRER_MEDIUM = "referrer_medium",
220
+ REFERRER_SOURCE = "referrer_source",
221
+ REFERRER_TERM = "referrer_term",
222
+ UTM_CAMPAIGN = "utm_campaign",
223
+ UTM_SOURCE = "utm_source",
224
+ UTM_MEDIUM = "utm_medium",
225
+ UTM_TERM = "utm_term",
226
+ UTM_CONTENT = "utm_content",
227
+ CLICK_NETWORK = "click_network",
228
+ ADBLOCK_DETECTED = "adblock_detected",
229
+ TIMEZONE = "timezone",
230
+ LOCALE = "locale",
231
+ CAMPAIGN = "campaign",
232
+ ADSET = "adset",
233
+ AD = "ad",
234
+ CUSTOMER_TYPE = "customer_type",
235
+ AD_SOURCE = "ad_source",
236
+ PRODUCT = "product",
237
+ VARIANT = "variant"
238
+ }
239
+ export declare enum ATTRIBUTION_MEASURE {
240
+ PURCHASES = "purchases",
241
+ PURCHASES_NET_REVENUE = "purchases_net_revenue",
242
+ PURCHASES_GROSS_REVENUE = "purchases_gross_revenue",
243
+ PURCHASES_TOTAL_REVENUE = "purchases_total_revenue",
244
+ GROSS_AOV = "gross_average_order_value",
245
+ NET_AOV = "net_average_order_value",
246
+ NEW_CUSTOMERS = "new_customers",
247
+ NEW_CUSTOMER_PURCHASES = "new_customer_purchases",
248
+ NEW_CUSTOMER_PURCHASES_NET_REVENUE = "new_customer_purchases_net_revenue",
249
+ NEW_CUSTOMER_PURCHASES_GROSS_REVENUE = "new_customer_purchases_gross_revenue",
250
+ NEW_CUSTOMER_PURCHASES_TOTAL_REVENUE = "new_customer_purchases_total_revenue",
251
+ NEW_CUSTOMER_PURCHASES_GROSS_AOV = "new_customer_purchases_gross_aov",
252
+ NEW_CUSTOMER_PURCHASES_NET_AOV = "new_customer_purchases_net_aov",
253
+ NEW_CUSTOMER_PERCENT = "new_customer_percent",
254
+ RETURNING_CUSTOMER_PERCENT = "returning_customer_percent",
255
+ CPA = "cpa",
256
+ NEW_CUSTOMER_CPA = "new_customer_cpa",
257
+ ROAS = "roas",
258
+ NEW_CUSTOMER_ROAS = "new_customer_roas",
259
+ FB_SPEND = "fb_spend",
260
+ FB_ROAS = "fb_roas",
261
+ ORDER_ID = "order_id",
262
+ ORDER_NAME = "orderName",
263
+ ORDER_CREATED_DATE = "order_created_date",
264
+ ORDER_IS_NEW_CUSTOMER = "order_is_new_customer",
265
+ ORDER_GROSS_SALE_PRICE = "order_gross_sale_price",
266
+ ORDER_NET_SALE_PRICE = "order_net_sale_price",
267
+ ORDER_CUSTOMER_EMAIL = "order_customer_email",
268
+ ORDER_CUSTOMER_PHONE = "order_customer_phone",
269
+ ORDER_SOURCE_TOUCHPOINTS = "order_source_touchpoints"
270
+ }
271
+ export declare enum ATTRIBUTION_DIMENSION {
272
+ SOURCE = "source",
273
+ MEDIUM = "medium",
274
+ CAMPAIGN = "campaign",
275
+ TERM = "term",
276
+ CONTENT = "content",
277
+ SOURCE_MEDIUM = "source_medium",
278
+ SOURCE_CAMPAIGN = "source_campaign",
279
+ AD_SET = "ad_set",
280
+ AD = "ad",
281
+ ORDER = "order",
282
+ NEW_CUSTOMER_ORDER = "new_customer_order"
283
+ }
284
+ export declare enum ATTRIBUTION_MODEL {
285
+ FIRST_CLICK = "first_click",
286
+ LAST_CLICK = "last_click",
287
+ ANY_CLICK = "any_click"
288
+ }
289
+ export declare enum PAGES_REPORT_DIMENSION {
290
+ LANDING_PAGE = "landing_page",
291
+ EXIT_PAGE = "exit_page"
292
+ }