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

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 (221) 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 -106
  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 +60 -60
  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 +18 -17
  24. package/dist/cjs/types/api/index.js +34 -33
  25. package/dist/cjs/types/api/index.js.map +1 -1
  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/measures/definitions/core-channel-measure-definitions.d.ts +13 -0
  29. package/dist/cjs/types/api/measures/definitions/core-channel-measure-definitions.js +17 -0
  30. package/dist/cjs/types/api/measures/definitions/core-channel-measure-definitions.js.map +1 -0
  31. package/dist/cjs/types/api/measures/definitions/core-measure-definitions.d.ts +103 -0
  32. package/dist/cjs/types/api/measures/definitions/core-measure-definitions.js +107 -0
  33. package/dist/cjs/types/api/measures/definitions/core-measure-definitions.js.map +1 -0
  34. package/dist/cjs/types/api/measures/definitions/facebook-measure-definitions.d.ts +123 -0
  35. package/dist/cjs/types/api/measures/definitions/facebook-measure-definitions.js +127 -0
  36. package/dist/cjs/types/api/measures/definitions/facebook-measure-definitions.js.map +1 -0
  37. package/dist/cjs/types/api/measures/definitions/google-measure-definitions.d.ts +53 -0
  38. package/dist/cjs/types/api/measures/definitions/google-measure-definitions.js +57 -0
  39. package/dist/cjs/types/api/measures/definitions/google-measure-definitions.js.map +1 -0
  40. package/dist/cjs/types/api/measures/definitions/index.d.ts +7 -0
  41. package/dist/cjs/types/api/measures/definitions/index.js +24 -0
  42. package/dist/cjs/types/api/measures/definitions/index.js.map +1 -0
  43. package/dist/cjs/types/api/measures/definitions/measure-definitions.d.ts +1282 -0
  44. package/dist/cjs/types/api/measures/definitions/measure-definitions.js +168 -0
  45. package/dist/cjs/types/api/measures/definitions/measure-definitions.js.map +1 -0
  46. package/dist/cjs/types/api/measures/definitions/shopify-measure-definitions.d.ts +554 -0
  47. package/dist/cjs/types/api/measures/definitions/shopify-measure-definitions.js +558 -0
  48. package/dist/cjs/types/api/measures/definitions/shopify-measure-definitions.js.map +1 -0
  49. package/dist/cjs/types/api/measures/definitions/tracked-measure-definitions.d.ts +350 -0
  50. package/dist/cjs/types/api/measures/definitions/tracked-measure-definitions.js +354 -0
  51. package/dist/cjs/types/api/measures/definitions/tracked-measure-definitions.js.map +1 -0
  52. package/dist/cjs/types/api/measures/index.d.ts +2 -0
  53. package/dist/cjs/types/api/measures/index.js +19 -0
  54. package/dist/cjs/types/api/measures/index.js.map +1 -0
  55. package/dist/cjs/types/api/measures/measures.d.ts +192 -0
  56. package/dist/cjs/types/api/measures/measures.js +197 -0
  57. package/dist/cjs/types/api/measures/measures.js.map +1 -0
  58. package/dist/cjs/types/api/pixel-setup-health.d.ts +19 -19
  59. package/dist/cjs/types/api/pixel-setup-health.js +2 -2
  60. package/dist/cjs/types/api/query.d.ts +147 -330
  61. package/dist/cjs/types/api/query.js +90 -275
  62. package/dist/cjs/types/api/query.js.map +1 -1
  63. package/dist/cjs/types/api/shopify-app-install.d.ts +40 -40
  64. package/dist/cjs/types/api/shopify-app-install.js +14 -14
  65. package/dist/cjs/types/api/subscription.d.ts +155 -155
  66. package/dist/cjs/types/api/subscription.js +47 -47
  67. package/dist/cjs/types/api/tracking-events.d.ts +15 -15
  68. package/dist/cjs/types/api/tracking-events.js +2 -2
  69. package/dist/cjs/types/api/user.d.ts +13 -13
  70. package/dist/cjs/types/api/user.js +2 -2
  71. package/dist/cjs/types/common/address.d.ts +15 -15
  72. package/dist/cjs/types/common/address.js +2 -2
  73. package/dist/cjs/types/common/currency.d.ts +1 -1
  74. package/dist/cjs/types/common/currency.js +63 -63
  75. package/dist/cjs/types/common/index.d.ts +2 -2
  76. package/dist/cjs/types/common/index.js +18 -18
  77. package/dist/cjs/types/event/base/event-name-enum.d.ts +59 -59
  78. package/dist/cjs/types/event/base/event-name-enum.js +65 -65
  79. package/dist/cjs/types/event/base/event.d.ts +20 -20
  80. package/dist/cjs/types/event/base/event.js +10 -10
  81. package/dist/cjs/types/event/base/index.d.ts +2 -2
  82. package/dist/cjs/types/event/base/index.js +18 -18
  83. package/dist/cjs/types/event/context/event-context-identity.d.ts +21 -21
  84. package/dist/cjs/types/event/context/event-context-identity.js +2 -2
  85. package/dist/cjs/types/event/context/event-context.d.ts +196 -196
  86. package/dist/cjs/types/event/context/event-context.js +2 -2
  87. package/dist/cjs/types/event/context/index.d.ts +2 -2
  88. package/dist/cjs/types/event/context/index.js +18 -18
  89. package/dist/cjs/types/event/index.d.ts +5 -5
  90. package/dist/cjs/types/event/index.js +21 -21
  91. package/dist/cjs/types/event/log-event.d.ts +35 -35
  92. package/dist/cjs/types/event/log-event.js +22 -22
  93. package/dist/cjs/types/event/metric-event.d.ts +13 -13
  94. package/dist/cjs/types/event/metric-event.js +2 -2
  95. package/dist/cjs/types/event/tracking-event.d.ts +62 -62
  96. package/dist/cjs/types/event/tracking-event.js +2 -2
  97. package/dist/cjs/types/event-bus-event.d.ts +25 -25
  98. package/dist/cjs/types/event-bus-event.js +2 -2
  99. package/dist/cjs/types/fingerprint/browser-attributes.d.ts +60 -60
  100. package/dist/cjs/types/fingerprint/browser-attributes.js +2 -2
  101. package/dist/cjs/types/fingerprint/index.d.ts +6 -6
  102. package/dist/cjs/types/fingerprint/index.js +18 -18
  103. package/dist/cjs/types/fingerprint/server-attributes.d.ts +50 -50
  104. package/dist/cjs/types/fingerprint/server-attributes.js +2 -2
  105. package/dist/cjs/types/index.d.ts +7 -7
  106. package/dist/cjs/types/index.js +23 -23
  107. package/dist/cjs/types/third-party-event-configuration-types.d.ts +10 -10
  108. package/dist/cjs/types/third-party-event-configuration-types.js +2 -2
  109. package/dist/cjs/types/tracking-event-ingest-message.d.ts +10 -10
  110. package/dist/cjs/types/tracking-event-ingest-message.js +2 -2
  111. package/dist/esm/index.d.ts +1 -1
  112. package/dist/esm/index.js +1 -1
  113. package/dist/esm/types/api/account.d.ts +62 -62
  114. package/dist/esm/types/api/account.js +20 -20
  115. package/dist/esm/types/api/contact-acquisition.d.ts +39 -39
  116. package/dist/esm/types/api/contact-acquisition.js +13 -13
  117. package/dist/esm/types/api/destination-tracked-events.d.ts +11 -11
  118. package/dist/esm/types/api/destination-tracked-events.js +1 -1
  119. package/dist/esm/types/api/destinations/destination-catalog.d.ts +30 -30
  120. package/dist/esm/types/api/destinations/destination-catalog.js +1 -1
  121. package/dist/esm/types/api/destinations/destinations.d.ts +93 -93
  122. package/dist/esm/types/api/destinations/destinations.js +40 -40
  123. package/dist/esm/types/api/destinations/third-party-contact-acquisition-configs.d.ts +9 -9
  124. package/dist/esm/types/api/destinations/third-party-contact-acquisition-configs.js +1 -1
  125. package/dist/esm/types/api/destinations/third-party-destination-configs.d.ts +106 -106
  126. package/dist/esm/types/api/destinations/third-party-destination-configs.js +6 -6
  127. package/dist/esm/types/api/destinations/third-party-integration-configs.d.ts +60 -60
  128. package/dist/esm/types/api/destinations/third-party-integration-configs.js +8 -8
  129. package/dist/esm/types/api/event-last-seen.d.ts +6 -6
  130. package/dist/esm/types/api/event-last-seen.js +1 -1
  131. package/dist/esm/types/api/event-status.d.ts +18 -18
  132. package/dist/esm/types/api/event-status.js +6 -6
  133. package/dist/esm/types/api/index.d.ts +18 -17
  134. package/dist/esm/types/api/index.js +18 -17
  135. package/dist/esm/types/api/index.js.map +1 -1
  136. package/dist/esm/types/api/log-events.d.ts +22 -22
  137. package/dist/esm/types/api/log-events.js +1 -1
  138. package/dist/esm/types/api/measures/definitions/core-channel-measure-definitions.d.ts +13 -0
  139. package/dist/esm/types/api/measures/definitions/core-channel-measure-definitions.js +14 -0
  140. package/dist/esm/types/api/measures/definitions/core-channel-measure-definitions.js.map +1 -0
  141. package/dist/esm/types/api/measures/definitions/core-measure-definitions.d.ts +103 -0
  142. package/dist/esm/types/api/measures/definitions/core-measure-definitions.js +104 -0
  143. package/dist/esm/types/api/measures/definitions/core-measure-definitions.js.map +1 -0
  144. package/dist/esm/types/api/measures/definitions/facebook-measure-definitions.d.ts +123 -0
  145. package/dist/esm/types/api/measures/definitions/facebook-measure-definitions.js +124 -0
  146. package/dist/esm/types/api/measures/definitions/facebook-measure-definitions.js.map +1 -0
  147. package/dist/esm/types/api/measures/definitions/google-measure-definitions.d.ts +53 -0
  148. package/dist/esm/types/api/measures/definitions/google-measure-definitions.js +54 -0
  149. package/dist/esm/types/api/measures/definitions/google-measure-definitions.js.map +1 -0
  150. package/dist/esm/types/api/measures/definitions/index.d.ts +7 -0
  151. package/dist/esm/types/api/measures/definitions/index.js +8 -0
  152. package/dist/esm/types/api/measures/definitions/index.js.map +1 -0
  153. package/dist/esm/types/api/measures/definitions/measure-definitions.d.ts +1282 -0
  154. package/dist/esm/types/api/measures/definitions/measure-definitions.js +165 -0
  155. package/dist/esm/types/api/measures/definitions/measure-definitions.js.map +1 -0
  156. package/dist/esm/types/api/measures/definitions/shopify-measure-definitions.d.ts +554 -0
  157. package/dist/esm/types/api/measures/definitions/shopify-measure-definitions.js +555 -0
  158. package/dist/esm/types/api/measures/definitions/shopify-measure-definitions.js.map +1 -0
  159. package/dist/esm/types/api/measures/definitions/tracked-measure-definitions.d.ts +350 -0
  160. package/dist/esm/types/api/measures/definitions/tracked-measure-definitions.js +351 -0
  161. package/dist/esm/types/api/measures/definitions/tracked-measure-definitions.js.map +1 -0
  162. package/dist/esm/types/api/measures/index.d.ts +2 -0
  163. package/dist/esm/types/api/measures/index.js +3 -0
  164. package/dist/esm/types/api/measures/index.js.map +1 -0
  165. package/dist/esm/types/api/measures/measures.d.ts +192 -0
  166. package/dist/esm/types/api/measures/measures.js +194 -0
  167. package/dist/esm/types/api/measures/measures.js.map +1 -0
  168. package/dist/esm/types/api/pixel-setup-health.d.ts +19 -19
  169. package/dist/esm/types/api/pixel-setup-health.js +1 -1
  170. package/dist/esm/types/api/query.d.ts +147 -330
  171. package/dist/esm/types/api/query.js +87 -272
  172. package/dist/esm/types/api/query.js.map +1 -1
  173. package/dist/esm/types/api/shopify-app-install.d.ts +40 -40
  174. package/dist/esm/types/api/shopify-app-install.js +11 -11
  175. package/dist/esm/types/api/subscription.d.ts +155 -155
  176. package/dist/esm/types/api/subscription.js +44 -44
  177. package/dist/esm/types/api/tracking-events.d.ts +15 -15
  178. package/dist/esm/types/api/tracking-events.js +1 -1
  179. package/dist/esm/types/api/user.d.ts +13 -13
  180. package/dist/esm/types/api/user.js +1 -1
  181. package/dist/esm/types/common/address.d.ts +15 -15
  182. package/dist/esm/types/common/address.js +1 -1
  183. package/dist/esm/types/common/currency.d.ts +1 -1
  184. package/dist/esm/types/common/currency.js +60 -60
  185. package/dist/esm/types/common/index.d.ts +2 -2
  186. package/dist/esm/types/common/index.js +2 -2
  187. package/dist/esm/types/event/base/event-name-enum.d.ts +59 -59
  188. package/dist/esm/types/event/base/event-name-enum.js +62 -62
  189. package/dist/esm/types/event/base/event.d.ts +20 -20
  190. package/dist/esm/types/event/base/event.js +7 -7
  191. package/dist/esm/types/event/base/index.d.ts +2 -2
  192. package/dist/esm/types/event/base/index.js +2 -2
  193. package/dist/esm/types/event/context/event-context-identity.d.ts +21 -21
  194. package/dist/esm/types/event/context/event-context-identity.js +1 -1
  195. package/dist/esm/types/event/context/event-context.d.ts +196 -196
  196. package/dist/esm/types/event/context/event-context.js +1 -1
  197. package/dist/esm/types/event/context/index.d.ts +2 -2
  198. package/dist/esm/types/event/context/index.js +2 -2
  199. package/dist/esm/types/event/index.d.ts +5 -5
  200. package/dist/esm/types/event/index.js +5 -5
  201. package/dist/esm/types/event/log-event.d.ts +35 -35
  202. package/dist/esm/types/event/log-event.js +19 -19
  203. package/dist/esm/types/event/metric-event.d.ts +13 -13
  204. package/dist/esm/types/event/metric-event.js +1 -1
  205. package/dist/esm/types/event/tracking-event.d.ts +62 -62
  206. package/dist/esm/types/event/tracking-event.js +1 -1
  207. package/dist/esm/types/event-bus-event.d.ts +25 -25
  208. package/dist/esm/types/event-bus-event.js +1 -1
  209. package/dist/esm/types/fingerprint/browser-attributes.d.ts +60 -60
  210. package/dist/esm/types/fingerprint/browser-attributes.js +1 -1
  211. package/dist/esm/types/fingerprint/index.d.ts +6 -6
  212. package/dist/esm/types/fingerprint/index.js +2 -2
  213. package/dist/esm/types/fingerprint/server-attributes.d.ts +50 -50
  214. package/dist/esm/types/fingerprint/server-attributes.js +1 -1
  215. package/dist/esm/types/index.d.ts +7 -7
  216. package/dist/esm/types/index.js +7 -7
  217. package/dist/esm/types/third-party-event-configuration-types.d.ts +10 -10
  218. package/dist/esm/types/third-party-event-configuration-types.js +1 -1
  219. package/dist/esm/types/tracking-event-ingest-message.d.ts +10 -10
  220. package/dist/esm/types/tracking-event-ingest-message.js +1 -1
  221. package/package.json +1 -1
@@ -1,330 +1,147 @@
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.purchases_value",
118
- FB_PURCHASES_COST = "fb.purchases_cost",
119
- FB_NEW_CUSTOMER_PURCHASES = "fb.new_customer_purchases",
120
- FB_NEW_CUSTOMER_PURCHASES_VALUE = "fb.new_customer_purchases_value",
121
- FB_NEW_CUSTOMER_PURCHASES_COST = "fb.new_customer_purchases_cost",
122
- FB_NEW_CUSTOMER_CPA = "fb.new_customer_cpa",
123
- FB_NEW_CUSTOMER_ROAS = "fb.new_customer_roas",
124
- FB_SPEND_GROSS_PERCENT = "fb.spend_gross_percent",
125
- FB_SPEND_NET_PERCENT = "fb.spend_net_percent",
126
- FB_MER_GROSS = "fb.mer_gross",
127
- FB_MER_NET = "fb.mer_net",
128
- FB_REACH = "fb.reach",
129
- FB_CPP = "fb.cpp",
130
- FB_UNIQUE_CLICKS = "fb.unique_clicks",
131
- FB_COST_PER_UNIQUE_CLICK = "fb.cost_per_unique_click",
132
- FB_INLINE_CLICKS = "fb.inline_clicks",
133
- FB_COST_PER_INLINE_CLICK = "fb.cost_per_inline_click",
134
- FB_OUTBOUND_CLICKS = "fb.outbound_clicks",
135
- FB_COST_PER_OUTBOUND_CLICK = "fb.cost_per_outbound_click",
136
- FB_VIEW_CONTENTS = "fb.view_contents",
137
- FB_VIEW_CONTENTS_VALUE = "fb.view_contents_value",
138
- FB_VIEW_CONTENTS_COST = "fb.view_contents_cost",
139
- FB_ADD_TO_CARTS = "fb.add_to_carts",
140
- FB_ADD_TO_CARTS_VALUE = "fb.add_to_carts_value",
141
- FB_ADD_TO_CARTS_COST = "fb.add_to_carts_cost",
142
- FB_INITIATE_CHECKOUTS = "fb.initiate_checkouts",
143
- FB_INITIATE_CHECKOUTS_VALUE = "fb.initiate_checkouts_value",
144
- FB_INITIATE_CHECKOUTS_COST = "fb.initiate_checkouts_cost",
145
- FB_LEADS = "fb.leads",
146
- FB_LEADS_VALUE = "fb.leads_value",
147
- FB_LEADS_COST = "fb.leads_cost",
148
- FB_VIDEO_VIEWS = "fb.video_views",
149
- FB_VIDEO_VIEWS_COST = "fb.video_views_cost",
150
- FB_VIDEO_VIEWS_15_SEC_COST = "fb.video_views_15sec_cost",
151
- FB_VIDEO_VIEWS_THRUPLAY_COST = "fb.video_views_thruplay_cost",
152
- FB_VIDEO_PLAYS = "fb.video_plays",
153
- GOOGLE_CPC = "google.cpc",
154
- GOOGLE_CTR = "google.ctr",
155
- GOOGLE_CPM = "google.cpm",
156
- GOOGLE_ROAS = "google.roas",
157
- GOOGLE_SPEND = "google.spend",
158
- GOOGLE_CPA = "google.cpa",
159
- GOOGLE_IMPRESSIONS = "google.impressions",
160
- GOOGLE_CLICKS = "google.clicks",
161
- GOOGLE_FREQUENCY = "google.frequency",
162
- GOOGLE_PURCHASES = "google.purchases",
163
- GOOGLE_PURCHASES_VALUE = "google.purchases_value",
164
- GOOGLE_PURCHASES_COST = "google.purchases_cost",
165
- GOOGLE_NEW_CUSTOMER_PURCHASES = "google.new_customer_purchases",
166
- GOOGLE_NEW_CUSTOMER_PURCHASES_VALUE = "google.new_customer_purchases_value",
167
- GOOGLE_NEW_CUSTOMER_PURCHASES_COST = "google.new_customer_purchases_cost",
168
- GOOGLE_NEW_CUSTOMER_CPA = "google.new_customer_cpa",
169
- GOOGLE_NEW_CUSTOMER_ROAS = "google.new_customer_roas",
170
- GOOGLE_SPEND_GROSS_PERCENT = "google.spend_gross_percent",
171
- GOOGLE_SPEND_NET_PERCENT = "google.spend_net_percent",
172
- GOOGLE_MER_GROSS = "google.mer_gross",
173
- GOOGLE_MER_NET = "google.mer_net",
174
- GOOGLE_CPV = "google.cpv",
175
- GOOGLE_CPI = "google.cpi",
176
- GOOGLE_VIDEO_VIEWS = "google.video_views",
177
- BLENDED_CPC = "blended.cpc",
178
- BLENDED_CTR = "blended.ctr",
179
- BLENDED_CPM = "blended.cpm",
180
- BLENDED_ROAS = "blended.roas",
181
- BLENDED_AD_SPEND = "blended.ad_spend",
182
- BLENDED_CPA = "blended.cpa",
183
- BLENDED_IMPRESSIONS = "blended.impressions",
184
- BLENDED_CLICKS = "blended.clicks",
185
- BLENDED_FREQUENCY = "blended.frequency",
186
- BLENDED_PURCHASES = "blended.purchases",
187
- BLENDED_PURCHASES_VALUE = "blended.purchases_value",
188
- BLENDED_NEW_CUSTOMER_PURCHASES = "blended.new_customer_purchases",
189
- BLENDED_NEW_CUSTOMER_PURCHASES_VALUE = "blended.new_customer_purchases_value",
190
- BLENDED_NEW_CUSTOMER_CPA = "blended.new_customer_cpa",
191
- BLENDED_NEW_CUSTOMER_ROAS = "blended.new_customer_roas",
192
- BLENDED_SPEND_GROSS_PERCENT = "blended.spend_gross_percent",
193
- BLENDED_SPEND_NET_PERCENT = "blended.spend_net_percent",
194
- BLENDED_MER_GROSS = "blended.mer_gross",
195
- BLENDED_MER_NET = "blended.mer_net",
196
- CORE_CPA = "core.cpa",
197
- CORE_NEW_CUSTOMER_CPA = "core.new_customer_cpa",
198
- CORE_ROAS = "core.roas",
199
- CORE_NEW_CUSTOMER_ROAS = "core.new_customer_roas",
200
- CORE_RRADD = "core.rradd",
201
- CORE_RRADD_GROSS_PERCENT = "core.rradd_gross_percent"
202
- }
203
- export interface Query {
204
- pixelId: string;
205
- measures: MeasureConfig[];
206
- dateRange: DateRange;
207
- compareDateRange?: DateRange;
208
- granularity?: GRANULARITY;
209
- dimensions?: DIMENSION[];
210
- filters?: any[];
211
- timezone?: string;
212
- orderSettings?: OrderSettings;
213
- }
214
- export interface MeasureConfig {
215
- measure: MEASURE;
216
- pacing?: boolean;
217
- }
218
- export interface OrderSettings {
219
- countVoidedOrders?: boolean;
220
- countPendingOrders?: boolean;
221
- }
222
- export interface AppliedDimensions {
223
- dimensionName?: string;
224
- dimensionValue?: string;
225
- }
226
- export declare type MeasureDataRow = {
227
- [key: string]: any;
228
- dt?: string;
229
- start?: string;
230
- end?: string;
231
- };
232
- export interface QueryData {
233
- primary?: MeasureDataRow[];
234
- compare?: MeasureDataRow[];
235
- }
236
- export interface MeasureDetail {
237
- measure: MEASURE;
238
- isAverage: boolean;
239
- isPercentage: boolean;
240
- calculatedAverage: boolean;
241
- success: boolean;
242
- primaryAvg: number;
243
- compareAvg: number;
244
- primarySum: number;
245
- compareSum: number;
246
- percentDiff: number;
247
- hasPacing: boolean;
248
- }
249
- export interface QueryResult {
250
- granularity: GRANULARITY;
251
- dimensions: DIMENSION[];
252
- dateRange: DateRange;
253
- compareDateRange?: DateRange;
254
- measureDetails: MeasureDetail[] | null;
255
- data: QueryData | null;
256
- }
257
- export interface QueryResponse {
258
- results: QueryResult[];
259
- }
260
- export declare enum DIMENSION {
261
- DEVICE_MODEL = "device_model",
262
- DEVICE_VENDOR = "device_vendor",
263
- DEVICE_TYPE = "device_type",
264
- BROWSER = "browser",
265
- BROWSER_VERSION = "browser_version",
266
- BROWSER_OS = "browser_os",
267
- OS = "OS",
268
- LANDING_PATH = "landing_path",
269
- PAGE_PATH = "path",
270
- PAGE_TITLE = "title",
271
- QUERY_STRING = "query",
272
- GATEWAY = "gateway",
273
- CURRENCY = "currency",
274
- SHIPPING_CODE = "shipping_code",
275
- IS_MOBILE = "is_mobile",
276
- IS_WIRELESS = "is_wireless",
277
- CITY = "city",
278
- PROVINCE_CODE = "province_code",
279
- PROVINCE = "province",
280
- COUNTRY_CODE = "country_code",
281
- COUNTRY = "country",
282
- POSTAL_CODE = "postal_code",
283
- FINANCIAL_STATUS = "financial_status",
284
- FULFILLMENT_STATUS = "fulfillment_status",
285
- DISCOUNT_CODE = "discount_code",
286
- REFERRER = "referrer",
287
- REFERRER_MEDIUM = "referrer_medium",
288
- REFERRER_SOURCE = "referrer_source",
289
- REFERRER_TERM = "referrer_term",
290
- UTM_SOURCE = "utm_source",
291
- UTM_CAMPAIGN = "utm_campaign",
292
- UTM_MEDIUM = "utm_medium",
293
- UTM_TERM = "utm_term",
294
- UTM_CONTENT = "utm_content",
295
- UTM_SOURCE_MEDIUM = "utm_source_medium",
296
- UTM_SOURCE_CAMPAIGN = "utm_source_campaign",
297
- UTM_ADSET = "utm_adset",
298
- UTM_AD = "utm_ad",
299
- CLICK_NETWORK = "click_network",
300
- ADBLOCK_DETECTED = "adblock_detected",
301
- TIMEZONE = "timezone",
302
- LOCALE = "locale",
303
- CAMPAIGN = "campaign",
304
- ADSET = "adset",
305
- AD = "ad",
306
- CUSTOMER_TYPE = "customer_type",
307
- AD_SOURCE = "ad_source",
308
- PRODUCT = "product",
309
- VARIANT = "variant",
310
- ORDER = "order",
311
- NEW_CUSTOMER_ORDER = "new_customer_order"
312
- }
313
- export declare enum FIELDS {
314
- SHOPIFY_ORDER_ID = "shopify.order_id",
315
- SHOPIFY_ORDER_NAME = "shopify.order_name",
316
- SHOPIFY_ORDER_CREATED_DATE = "shopify.order_created_date",
317
- SHOPIFY_ORDER_IS_NEW_CUSTOMER = "shopify.order_is_new_customer",
318
- SHOPIFY_ORDER_CUSTOMER_EMAIL = "shopify.order_customer_email",
319
- SHOPIFY_ORDER_CUSTOMER_PHONE = "shopify.order_customer_phone",
320
- TRACKED_CONVERSION_TOUCHPOINTS = "tracked.conversion_touchpoints"
321
- }
322
- export declare enum ATTRIBUTION_MODEL {
323
- FIRST_CLICK = "first_click",
324
- LAST_CLICK = "last_click",
325
- ANY_CLICK = "any_click"
326
- }
327
- export declare enum PAGES_REPORT_DIMENSION {
328
- LANDING_PAGE = "landing_page",
329
- EXIT_PAGE = "exit_page"
330
- }
1
+ import { MEASURE } from './measures/measures';
2
+ export interface DateRange {
3
+ start: string;
4
+ end: string;
5
+ timezone?: string;
6
+ utcStart?: string;
7
+ utcEnd?: string;
8
+ }
9
+ export declare enum GRANULARITY {
10
+ NONE = "none",
11
+ SECOND = "second",
12
+ MINUTE = "minute",
13
+ HOUR = "hour",
14
+ DAY = "day",
15
+ WEEK = "week",
16
+ MONTH = "month",
17
+ QUARTER = "quarter",
18
+ YEAR = "year"
19
+ }
20
+ export interface Query {
21
+ pixelId: string;
22
+ measures: MeasureConfig[];
23
+ dateRange: DateRange;
24
+ compareDateRange?: DateRange;
25
+ granularity?: GRANULARITY;
26
+ dimensions?: DIMENSION[];
27
+ filters?: any[];
28
+ timezone?: string;
29
+ orderSettings?: OrderSettings;
30
+ }
31
+ export interface MeasureConfig {
32
+ measure: MEASURE;
33
+ pacing?: boolean;
34
+ }
35
+ export interface OrderSettings {
36
+ countVoidedOrders?: boolean;
37
+ countPendingOrders?: boolean;
38
+ }
39
+ export interface AppliedDimensions {
40
+ dimensionName?: string;
41
+ dimensionValue?: string;
42
+ }
43
+ export declare type MeasureDataRow = {
44
+ [key: string]: any;
45
+ dt?: string;
46
+ start?: string;
47
+ end?: string;
48
+ };
49
+ export interface QueryData {
50
+ primary?: MeasureDataRow[];
51
+ compare?: MeasureDataRow[];
52
+ }
53
+ export interface MeasureDetail {
54
+ measure: MEASURE;
55
+ isAverage: boolean;
56
+ isPercentage: boolean;
57
+ calculatedAverage: boolean;
58
+ success: boolean;
59
+ primaryAvg: number;
60
+ compareAvg: number;
61
+ primarySum: number;
62
+ compareSum: number;
63
+ percentDiff: number;
64
+ hasPacing: boolean;
65
+ }
66
+ export interface QueryResult {
67
+ granularity: GRANULARITY;
68
+ dimensions: DIMENSION[];
69
+ dateRange: DateRange;
70
+ compareDateRange?: DateRange;
71
+ measureDetails: MeasureDetail[] | null;
72
+ data: QueryData | null;
73
+ }
74
+ export interface QueryResponse {
75
+ results: QueryResult[];
76
+ }
77
+ export declare enum DIMENSION {
78
+ DEVICE_MODEL = "device_model",
79
+ DEVICE_VENDOR = "device_vendor",
80
+ DEVICE_TYPE = "device_type",
81
+ BROWSER = "browser",
82
+ BROWSER_VERSION = "browser_version",
83
+ BROWSER_OS = "browser_os",
84
+ OS = "OS",
85
+ LANDING_PATH = "landing_path",
86
+ PAGE_PATH = "path",
87
+ PAGE_TITLE = "title",
88
+ QUERY_STRING = "query",
89
+ GATEWAY = "gateway",
90
+ CURRENCY = "currency",
91
+ SHIPPING_CODE = "shipping_code",
92
+ IS_MOBILE = "is_mobile",
93
+ IS_WIRELESS = "is_wireless",
94
+ CITY = "city",
95
+ PROVINCE_CODE = "province_code",
96
+ PROVINCE = "province",
97
+ COUNTRY_CODE = "country_code",
98
+ COUNTRY = "country",
99
+ POSTAL_CODE = "postal_code",
100
+ FINANCIAL_STATUS = "financial_status",
101
+ FULFILLMENT_STATUS = "fulfillment_status",
102
+ DISCOUNT_CODE = "discount_code",
103
+ REFERRER = "referrer",
104
+ REFERRER_MEDIUM = "referrer_medium",
105
+ REFERRER_SOURCE = "referrer_source",
106
+ REFERRER_TERM = "referrer_term",
107
+ UTM_SOURCE = "utm_source",
108
+ UTM_CAMPAIGN = "utm_campaign",
109
+ UTM_MEDIUM = "utm_medium",
110
+ UTM_TERM = "utm_term",
111
+ UTM_CONTENT = "utm_content",
112
+ UTM_SOURCE_MEDIUM = "utm_source_medium",
113
+ UTM_SOURCE_CAMPAIGN = "utm_source_campaign",
114
+ UTM_ADSET = "utm_adset",
115
+ UTM_AD = "utm_ad",
116
+ CLICK_NETWORK = "click_network",
117
+ ADBLOCK_DETECTED = "adblock_detected",
118
+ TIMEZONE = "timezone",
119
+ LOCALE = "locale",
120
+ CAMPAIGN = "campaign",
121
+ ADSET = "adset",
122
+ AD = "ad",
123
+ CUSTOMER_TYPE = "customer_type",
124
+ AD_SOURCE = "ad_source",
125
+ PRODUCT = "product",
126
+ VARIANT = "variant",
127
+ ORDER = "order",
128
+ NEW_CUSTOMER_ORDER = "new_customer_order"
129
+ }
130
+ export declare enum FIELDS {
131
+ SHOPIFY_ORDER_ID = "shopify.order_id",
132
+ SHOPIFY_ORDER_NAME = "shopify.order_name",
133
+ SHOPIFY_ORDER_CREATED_DATE = "shopify.order_created_date",
134
+ SHOPIFY_ORDER_IS_NEW_CUSTOMER = "shopify.order_is_new_customer",
135
+ SHOPIFY_ORDER_CUSTOMER_EMAIL = "shopify.order_customer_email",
136
+ SHOPIFY_ORDER_CUSTOMER_PHONE = "shopify.order_customer_phone",
137
+ TRACKED_CONVERSION_TOUCHPOINTS = "tracked.conversion_touchpoints"
138
+ }
139
+ export declare enum ATTRIBUTION_MODEL {
140
+ FIRST_CLICK = "first_click",
141
+ LAST_CLICK = "last_click",
142
+ ANY_CLICK = "any_click"
143
+ }
144
+ export declare enum PAGES_REPORT_DIMENSION {
145
+ LANDING_PAGE = "landing_page",
146
+ EXIT_PAGE = "exit_page"
147
+ }