@adtrackify/at-tracking-event-types 3.5.24 → 3.5.25

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 (310) hide show
  1. package/README.md +12 -12
  2. package/dist/cjs/index.d.ts +1 -1
  3. package/dist/cjs/index.js +17 -17
  4. package/dist/cjs/types/api/account.d.ts +133 -133
  5. package/dist/cjs/types/api/account.js +84 -84
  6. package/dist/cjs/types/api/contact-acquisition/contact-acquisition.d.ts +106 -106
  7. package/dist/cjs/types/api/contact-acquisition/contact-acquisition.js +21 -21
  8. package/dist/cjs/types/api/contact-acquisition/email-verification.d.ts +30 -30
  9. package/dist/cjs/types/api/contact-acquisition/email-verification.js +11 -11
  10. package/dist/cjs/types/api/contact-acquisition/index.d.ts +6 -6
  11. package/dist/cjs/types/api/contact-acquisition/index.js +22 -22
  12. package/dist/cjs/types/api/contact-acquisition/purchased-contact.d.ts +35 -35
  13. package/dist/cjs/types/api/contact-acquisition/purchased-contact.js +8 -8
  14. package/dist/cjs/types/api/contact-acquisition/purchased-traits.d.ts +63 -63
  15. package/dist/cjs/types/api/contact-acquisition/purchased-traits.js +2 -2
  16. package/dist/cjs/types/api/contact-acquisition/third-party-contact.d.ts +44 -44
  17. package/dist/cjs/types/api/contact-acquisition/third-party-contact.js +2 -2
  18. package/dist/cjs/types/api/contact-acquisition/third-party-cookie-contact-acquisition.d.ts +6 -6
  19. package/dist/cjs/types/api/contact-acquisition/third-party-cookie-contact-acquisition.js +2 -2
  20. package/dist/cjs/types/api/dashboards/index.d.ts +1 -1
  21. package/dist/cjs/types/api/dashboards/index.js +17 -17
  22. package/dist/cjs/types/api/dashboards/widget.d.ts +126 -126
  23. package/dist/cjs/types/api/dashboards/widget.js +36 -36
  24. package/dist/cjs/types/api/destination-tracked-events.d.ts +11 -11
  25. package/dist/cjs/types/api/destination-tracked-events.js +3 -3
  26. package/dist/cjs/types/api/destinations/destination-catalog.d.ts +30 -30
  27. package/dist/cjs/types/api/destinations/destination-catalog.js +2 -2
  28. package/dist/cjs/types/api/destinations/destinations.d.ts +125 -125
  29. package/dist/cjs/types/api/destinations/destinations.js +56 -56
  30. package/dist/cjs/types/api/destinations/emq-health.d.ts +14 -16
  31. package/dist/cjs/types/api/destinations/emq-health.js +2 -2
  32. package/dist/cjs/types/api/destinations/index.d.ts +6 -6
  33. package/dist/cjs/types/api/destinations/index.js +22 -22
  34. package/dist/cjs/types/api/destinations/third-party-contact-acquisition-configs.d.ts +9 -9
  35. package/dist/cjs/types/api/destinations/third-party-contact-acquisition-configs.js +2 -2
  36. package/dist/cjs/types/api/destinations/third-party-destination-configs.d.ts +185 -185
  37. package/dist/cjs/types/api/destinations/third-party-destination-configs.js +23 -23
  38. package/dist/cjs/types/api/destinations/third-party-integration-configs.d.ts +67 -67
  39. package/dist/cjs/types/api/destinations/third-party-integration-configs.js +11 -11
  40. package/dist/cjs/types/api/emq/emq-types.d.ts +189 -160
  41. package/dist/cjs/types/api/emq/emq-types.js +49 -49
  42. package/dist/cjs/types/api/emq/emq-types.js.map +1 -1
  43. package/dist/cjs/types/api/emq/index.d.ts +1 -1
  44. package/dist/cjs/types/api/emq/index.js +17 -17
  45. package/dist/cjs/types/api/event-last-seen.d.ts +6 -6
  46. package/dist/cjs/types/api/event-last-seen.js +2 -2
  47. package/dist/cjs/types/api/event-status.d.ts +18 -18
  48. package/dist/cjs/types/api/event-status.js +9 -9
  49. package/dist/cjs/types/api/events/alert-events.d.ts +175 -175
  50. package/dist/cjs/types/api/events/alert-events.js +53 -53
  51. package/dist/cjs/types/api/events/health-events.d.ts +132 -0
  52. package/dist/cjs/types/api/events/health-events.js +43 -0
  53. package/dist/cjs/types/api/events/health-events.js.map +1 -0
  54. package/dist/cjs/types/api/events/index.d.ts +1 -1
  55. package/dist/cjs/types/api/events/index.js +17 -17
  56. package/dist/cjs/types/api/feature.d.ts +229 -229
  57. package/dist/cjs/types/api/feature.js +199 -199
  58. package/dist/cjs/types/api/index.d.ts +25 -25
  59. package/dist/cjs/types/api/index.js +41 -41
  60. package/dist/cjs/types/api/log-events.d.ts +22 -22
  61. package/dist/cjs/types/api/log-events.js +2 -2
  62. package/dist/cjs/types/api/measures/definitions/channel-measure-definitions.d.ts +2 -2
  63. package/dist/cjs/types/api/measures/definitions/channel-measure-definitions.js +1677 -1677
  64. package/dist/cjs/types/api/measures/definitions/core-measure-definitions.d.ts +2 -2
  65. package/dist/cjs/types/api/measures/definitions/core-measure-definitions.js +446 -446
  66. package/dist/cjs/types/api/measures/definitions/emq-measure-definitions.d.ts +2 -2
  67. package/dist/cjs/types/api/measures/definitions/emq-measure-definitions.js +204 -204
  68. package/dist/cjs/types/api/measures/definitions/facebook-measure-definitions.d.ts +2 -2
  69. package/dist/cjs/types/api/measures/definitions/facebook-measure-definitions.js +1451 -1451
  70. package/dist/cjs/types/api/measures/definitions/google-measure-definitions.d.ts +2 -2
  71. package/dist/cjs/types/api/measures/definitions/google-measure-definitions.js +325 -325
  72. package/dist/cjs/types/api/measures/definitions/index.d.ts +13 -13
  73. package/dist/cjs/types/api/measures/definitions/index.js +29 -29
  74. package/dist/cjs/types/api/measures/definitions/measure-applicable-contexts.d.ts +9 -9
  75. package/dist/cjs/types/api/measures/definitions/measure-applicable-contexts.js +22 -22
  76. package/dist/cjs/types/api/measures/definitions/measure-categories.d.ts +19 -19
  77. package/dist/cjs/types/api/measures/definitions/measure-categories.js +23 -23
  78. package/dist/cjs/types/api/measures/definitions/measure-definitions.d.ts +40 -40
  79. package/dist/cjs/types/api/measures/definitions/measure-definitions.js +31 -31
  80. package/dist/cjs/types/api/measures/definitions/measure-value-type.d.ts +8 -8
  81. package/dist/cjs/types/api/measures/definitions/measure-value-type.js +12 -12
  82. package/dist/cjs/types/api/measures/definitions/shopify/shopify-measure-definitions.d.ts +2 -2
  83. package/dist/cjs/types/api/measures/definitions/shopify/shopify-measure-definitions.js +864 -864
  84. package/dist/cjs/types/api/measures/definitions/shopify/shopify-nc-measure-definitions.d.ts +2 -2
  85. package/dist/cjs/types/api/measures/definitions/shopify/shopify-nc-measure-definitions.js +446 -446
  86. package/dist/cjs/types/api/measures/definitions/shopify/shopify-rc-measure-definitions.d.ts +2 -2
  87. package/dist/cjs/types/api/measures/definitions/shopify/shopify-rc-measure-definitions.js +447 -447
  88. package/dist/cjs/types/api/measures/definitions/tracked-measure-definitions.d.ts +2 -2
  89. package/dist/cjs/types/api/measures/definitions/tracked-measure-definitions.js +509 -509
  90. package/dist/cjs/types/api/measures/index.d.ts +2 -2
  91. package/dist/cjs/types/api/measures/index.js +18 -18
  92. package/dist/cjs/types/api/measures/measures.d.ts +469 -469
  93. package/dist/cjs/types/api/measures/measures.js +473 -473
  94. package/dist/cjs/types/api/notification-settings.d.ts +23 -0
  95. package/dist/cjs/types/api/notification-settings.js +107 -0
  96. package/dist/cjs/types/api/notification-settings.js.map +1 -0
  97. package/dist/cjs/types/api/pixel-setup-health.d.ts +19 -19
  98. package/dist/cjs/types/api/pixel-setup-health.js +2 -2
  99. package/dist/cjs/types/api/promotion-code.d.ts +35 -35
  100. package/dist/cjs/types/api/promotion-code.js +9 -9
  101. package/dist/cjs/types/api/query.d.ts +153 -153
  102. package/dist/cjs/types/api/query.js +96 -96
  103. package/dist/cjs/types/api/shopify-app-install.d.ts +41 -41
  104. package/dist/cjs/types/api/shopify-app-install.js +14 -14
  105. package/dist/cjs/types/api/subscription.d.ts +192 -192
  106. package/dist/cjs/types/api/subscription.js +48 -48
  107. package/dist/cjs/types/api/tracking-events.d.ts +15 -15
  108. package/dist/cjs/types/api/tracking-events.js +2 -2
  109. package/dist/cjs/types/api/user-account.d.ts +32 -39
  110. package/dist/cjs/types/api/user-account.js +16 -16
  111. package/dist/cjs/types/api/user.d.ts +13 -13
  112. package/dist/cjs/types/api/user.js +2 -2
  113. package/dist/cjs/types/common/address.d.ts +22 -22
  114. package/dist/cjs/types/common/address.js +8 -8
  115. package/dist/cjs/types/common/currency.d.ts +1 -1
  116. package/dist/cjs/types/common/currency.js +63 -63
  117. package/dist/cjs/types/common/index.d.ts +2 -2
  118. package/dist/cjs/types/common/index.js +18 -18
  119. package/dist/cjs/types/event/base/event-name-enum.d.ts +134 -123
  120. package/dist/cjs/types/event/base/event-name-enum.js +140 -129
  121. package/dist/cjs/types/event/base/event-name-enum.js.map +1 -1
  122. package/dist/cjs/types/event/base/event.d.ts +20 -20
  123. package/dist/cjs/types/event/base/event.js +10 -10
  124. package/dist/cjs/types/event/base/index.d.ts +2 -2
  125. package/dist/cjs/types/event/base/index.js +18 -18
  126. package/dist/cjs/types/event/context/event-context-identity.d.ts +32 -32
  127. package/dist/cjs/types/event/context/event-context-identity.js +2 -2
  128. package/dist/cjs/types/event/context/event-context.d.ts +201 -201
  129. package/dist/cjs/types/event/context/event-context.js +2 -2
  130. package/dist/cjs/types/event/context/index.d.ts +2 -2
  131. package/dist/cjs/types/event/context/index.js +18 -18
  132. package/dist/cjs/types/event/index.d.ts +6 -6
  133. package/dist/cjs/types/event/index.js +22 -22
  134. package/dist/cjs/types/event/log-event.d.ts +35 -35
  135. package/dist/cjs/types/event/log-event.js +22 -22
  136. package/dist/cjs/types/event/metric-event.d.ts +13 -13
  137. package/dist/cjs/types/event/metric-event.js +2 -2
  138. package/dist/cjs/types/event/saas-event-properties.d.ts +47 -47
  139. package/dist/cjs/types/event/saas-event-properties.js +10 -10
  140. package/dist/cjs/types/event/tracking-event.d.ts +69 -69
  141. package/dist/cjs/types/event/tracking-event.js +2 -2
  142. package/dist/cjs/types/event-bus-event.d.ts +25 -25
  143. package/dist/cjs/types/event-bus-event.js +2 -2
  144. package/dist/cjs/types/fingerprint/browser-attributes.d.ts +60 -60
  145. package/dist/cjs/types/fingerprint/browser-attributes.js +2 -2
  146. package/dist/cjs/types/fingerprint/index.d.ts +6 -6
  147. package/dist/cjs/types/fingerprint/index.js +18 -18
  148. package/dist/cjs/types/fingerprint/server-attributes.d.ts +50 -50
  149. package/dist/cjs/types/fingerprint/server-attributes.js +2 -2
  150. package/dist/cjs/types/index.d.ts +7 -7
  151. package/dist/cjs/types/index.js +23 -23
  152. package/dist/cjs/types/third-party-event-configuration-types.d.ts +10 -10
  153. package/dist/cjs/types/third-party-event-configuration-types.js +2 -2
  154. package/dist/cjs/types/tracking-event-ingest-message.d.ts +12 -12
  155. package/dist/cjs/types/tracking-event-ingest-message.js +2 -2
  156. package/dist/esm/index.d.ts +1 -1
  157. package/dist/esm/index.js +1 -1
  158. package/dist/esm/types/api/account.d.ts +133 -133
  159. package/dist/esm/types/api/account.js +81 -81
  160. package/dist/esm/types/api/contact-acquisition/contact-acquisition.d.ts +106 -106
  161. package/dist/esm/types/api/contact-acquisition/contact-acquisition.js +18 -18
  162. package/dist/esm/types/api/contact-acquisition/email-verification.d.ts +30 -30
  163. package/dist/esm/types/api/contact-acquisition/email-verification.js +8 -8
  164. package/dist/esm/types/api/contact-acquisition/index.d.ts +6 -6
  165. package/dist/esm/types/api/contact-acquisition/index.js +6 -6
  166. package/dist/esm/types/api/contact-acquisition/purchased-contact.d.ts +35 -35
  167. package/dist/esm/types/api/contact-acquisition/purchased-contact.js +5 -5
  168. package/dist/esm/types/api/contact-acquisition/purchased-traits.d.ts +63 -63
  169. package/dist/esm/types/api/contact-acquisition/purchased-traits.js +1 -1
  170. package/dist/esm/types/api/contact-acquisition/third-party-contact.d.ts +44 -44
  171. package/dist/esm/types/api/contact-acquisition/third-party-contact.js +1 -1
  172. package/dist/esm/types/api/contact-acquisition/third-party-cookie-contact-acquisition.d.ts +6 -6
  173. package/dist/esm/types/api/contact-acquisition/third-party-cookie-contact-acquisition.js +1 -1
  174. package/dist/esm/types/api/dashboards/index.d.ts +1 -1
  175. package/dist/esm/types/api/dashboards/index.js +1 -1
  176. package/dist/esm/types/api/dashboards/widget.d.ts +126 -126
  177. package/dist/esm/types/api/dashboards/widget.js +33 -33
  178. package/dist/esm/types/api/destination-tracked-events.d.ts +11 -11
  179. package/dist/esm/types/api/destination-tracked-events.js +1 -1
  180. package/dist/esm/types/api/destinations/destination-catalog.d.ts +30 -30
  181. package/dist/esm/types/api/destinations/destination-catalog.js +1 -1
  182. package/dist/esm/types/api/destinations/destinations.d.ts +125 -125
  183. package/dist/esm/types/api/destinations/destinations.js +53 -53
  184. package/dist/esm/types/api/destinations/emq-health.d.ts +14 -16
  185. package/dist/esm/types/api/destinations/emq-health.js +1 -1
  186. package/dist/esm/types/api/destinations/index.d.ts +6 -6
  187. package/dist/esm/types/api/destinations/index.js +6 -6
  188. package/dist/esm/types/api/destinations/third-party-contact-acquisition-configs.d.ts +9 -9
  189. package/dist/esm/types/api/destinations/third-party-contact-acquisition-configs.js +1 -1
  190. package/dist/esm/types/api/destinations/third-party-destination-configs.d.ts +185 -185
  191. package/dist/esm/types/api/destinations/third-party-destination-configs.js +20 -20
  192. package/dist/esm/types/api/destinations/third-party-integration-configs.d.ts +67 -67
  193. package/dist/esm/types/api/destinations/third-party-integration-configs.js +8 -8
  194. package/dist/esm/types/api/emq/emq-types.d.ts +189 -160
  195. package/dist/esm/types/api/emq/emq-types.js +46 -46
  196. package/dist/esm/types/api/emq/emq-types.js.map +1 -1
  197. package/dist/esm/types/api/emq/index.d.ts +1 -1
  198. package/dist/esm/types/api/emq/index.js +1 -1
  199. package/dist/esm/types/api/event-last-seen.d.ts +6 -6
  200. package/dist/esm/types/api/event-last-seen.js +1 -1
  201. package/dist/esm/types/api/event-status.d.ts +18 -18
  202. package/dist/esm/types/api/event-status.js +6 -6
  203. package/dist/esm/types/api/events/alert-events.d.ts +175 -175
  204. package/dist/esm/types/api/events/alert-events.js +50 -50
  205. package/dist/esm/types/api/events/health-events.d.ts +132 -0
  206. package/dist/esm/types/api/events/health-events.js +40 -0
  207. package/dist/esm/types/api/events/health-events.js.map +1 -0
  208. package/dist/esm/types/api/events/index.d.ts +1 -1
  209. package/dist/esm/types/api/events/index.js +1 -1
  210. package/dist/esm/types/api/feature.d.ts +229 -229
  211. package/dist/esm/types/api/feature.js +196 -196
  212. package/dist/esm/types/api/index.d.ts +25 -25
  213. package/dist/esm/types/api/index.js +25 -25
  214. package/dist/esm/types/api/log-events.d.ts +22 -22
  215. package/dist/esm/types/api/log-events.js +1 -1
  216. package/dist/esm/types/api/measures/definitions/channel-measure-definitions.d.ts +2 -2
  217. package/dist/esm/types/api/measures/definitions/channel-measure-definitions.js +1674 -1674
  218. package/dist/esm/types/api/measures/definitions/core-measure-definitions.d.ts +2 -2
  219. package/dist/esm/types/api/measures/definitions/core-measure-definitions.js +443 -443
  220. package/dist/esm/types/api/measures/definitions/emq-measure-definitions.d.ts +2 -2
  221. package/dist/esm/types/api/measures/definitions/emq-measure-definitions.js +201 -201
  222. package/dist/esm/types/api/measures/definitions/facebook-measure-definitions.d.ts +2 -2
  223. package/dist/esm/types/api/measures/definitions/facebook-measure-definitions.js +1448 -1448
  224. package/dist/esm/types/api/measures/definitions/google-measure-definitions.d.ts +2 -2
  225. package/dist/esm/types/api/measures/definitions/google-measure-definitions.js +322 -322
  226. package/dist/esm/types/api/measures/definitions/index.d.ts +13 -13
  227. package/dist/esm/types/api/measures/definitions/index.js +13 -13
  228. package/dist/esm/types/api/measures/definitions/measure-applicable-contexts.d.ts +9 -9
  229. package/dist/esm/types/api/measures/definitions/measure-applicable-contexts.js +19 -19
  230. package/dist/esm/types/api/measures/definitions/measure-categories.d.ts +19 -19
  231. package/dist/esm/types/api/measures/definitions/measure-categories.js +20 -20
  232. package/dist/esm/types/api/measures/definitions/measure-definitions.d.ts +40 -40
  233. package/dist/esm/types/api/measures/definitions/measure-definitions.js +28 -28
  234. package/dist/esm/types/api/measures/definitions/measure-value-type.d.ts +8 -8
  235. package/dist/esm/types/api/measures/definitions/measure-value-type.js +9 -9
  236. package/dist/esm/types/api/measures/definitions/shopify/shopify-measure-definitions.d.ts +2 -2
  237. package/dist/esm/types/api/measures/definitions/shopify/shopify-measure-definitions.js +861 -861
  238. package/dist/esm/types/api/measures/definitions/shopify/shopify-nc-measure-definitions.d.ts +2 -2
  239. package/dist/esm/types/api/measures/definitions/shopify/shopify-nc-measure-definitions.js +443 -443
  240. package/dist/esm/types/api/measures/definitions/shopify/shopify-rc-measure-definitions.d.ts +2 -2
  241. package/dist/esm/types/api/measures/definitions/shopify/shopify-rc-measure-definitions.js +444 -444
  242. package/dist/esm/types/api/measures/definitions/tracked-measure-definitions.d.ts +2 -2
  243. package/dist/esm/types/api/measures/definitions/tracked-measure-definitions.js +506 -506
  244. package/dist/esm/types/api/measures/index.d.ts +2 -2
  245. package/dist/esm/types/api/measures/index.js +2 -2
  246. package/dist/esm/types/api/measures/measures.d.ts +469 -469
  247. package/dist/esm/types/api/measures/measures.js +470 -470
  248. package/dist/esm/types/api/notification-settings.d.ts +23 -0
  249. package/dist/esm/types/api/notification-settings.js +103 -0
  250. package/dist/esm/types/api/notification-settings.js.map +1 -0
  251. package/dist/esm/types/api/pixel-setup-health.d.ts +19 -19
  252. package/dist/esm/types/api/pixel-setup-health.js +1 -1
  253. package/dist/esm/types/api/promotion-code.d.ts +35 -35
  254. package/dist/esm/types/api/promotion-code.js +6 -6
  255. package/dist/esm/types/api/query.d.ts +153 -153
  256. package/dist/esm/types/api/query.js +93 -93
  257. package/dist/esm/types/api/shopify-app-install.d.ts +41 -41
  258. package/dist/esm/types/api/shopify-app-install.js +11 -11
  259. package/dist/esm/types/api/subscription.d.ts +192 -192
  260. package/dist/esm/types/api/subscription.js +45 -45
  261. package/dist/esm/types/api/tracking-events.d.ts +15 -15
  262. package/dist/esm/types/api/tracking-events.js +1 -1
  263. package/dist/esm/types/api/user-account.d.ts +32 -39
  264. package/dist/esm/types/api/user-account.js +13 -13
  265. package/dist/esm/types/api/user.d.ts +13 -13
  266. package/dist/esm/types/api/user.js +1 -1
  267. package/dist/esm/types/common/address.d.ts +22 -22
  268. package/dist/esm/types/common/address.js +5 -5
  269. package/dist/esm/types/common/currency.d.ts +1 -1
  270. package/dist/esm/types/common/currency.js +60 -60
  271. package/dist/esm/types/common/index.d.ts +2 -2
  272. package/dist/esm/types/common/index.js +2 -2
  273. package/dist/esm/types/event/base/event-name-enum.d.ts +134 -123
  274. package/dist/esm/types/event/base/event-name-enum.js +137 -126
  275. package/dist/esm/types/event/base/event-name-enum.js.map +1 -1
  276. package/dist/esm/types/event/base/event.d.ts +20 -20
  277. package/dist/esm/types/event/base/event.js +7 -7
  278. package/dist/esm/types/event/base/index.d.ts +2 -2
  279. package/dist/esm/types/event/base/index.js +2 -2
  280. package/dist/esm/types/event/context/event-context-identity.d.ts +32 -32
  281. package/dist/esm/types/event/context/event-context-identity.js +1 -1
  282. package/dist/esm/types/event/context/event-context.d.ts +201 -201
  283. package/dist/esm/types/event/context/event-context.js +1 -1
  284. package/dist/esm/types/event/context/index.d.ts +2 -2
  285. package/dist/esm/types/event/context/index.js +2 -2
  286. package/dist/esm/types/event/index.d.ts +6 -6
  287. package/dist/esm/types/event/index.js +6 -6
  288. package/dist/esm/types/event/log-event.d.ts +35 -35
  289. package/dist/esm/types/event/log-event.js +19 -19
  290. package/dist/esm/types/event/metric-event.d.ts +13 -13
  291. package/dist/esm/types/event/metric-event.js +1 -1
  292. package/dist/esm/types/event/saas-event-properties.d.ts +47 -47
  293. package/dist/esm/types/event/saas-event-properties.js +7 -7
  294. package/dist/esm/types/event/tracking-event.d.ts +69 -69
  295. package/dist/esm/types/event/tracking-event.js +1 -1
  296. package/dist/esm/types/event-bus-event.d.ts +25 -25
  297. package/dist/esm/types/event-bus-event.js +1 -1
  298. package/dist/esm/types/fingerprint/browser-attributes.d.ts +60 -60
  299. package/dist/esm/types/fingerprint/browser-attributes.js +1 -1
  300. package/dist/esm/types/fingerprint/index.d.ts +6 -6
  301. package/dist/esm/types/fingerprint/index.js +2 -2
  302. package/dist/esm/types/fingerprint/server-attributes.d.ts +50 -50
  303. package/dist/esm/types/fingerprint/server-attributes.js +1 -1
  304. package/dist/esm/types/index.d.ts +7 -7
  305. package/dist/esm/types/index.js +7 -7
  306. package/dist/esm/types/third-party-event-configuration-types.d.ts +10 -10
  307. package/dist/esm/types/third-party-event-configuration-types.js +1 -1
  308. package/dist/esm/types/tracking-event-ingest-message.d.ts +12 -12
  309. package/dist/esm/types/tracking-event-ingest-message.js +1 -1
  310. package/package.json +108 -108
@@ -1,444 +1,444 @@
1
- import { MEASURE } from '../measures.js';
2
- import { MEASURE_CATEGORY } from './measure-categories.js';
3
- import { MeasureValueType } from './measure-value-type.js';
4
- import { CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS, STANDARD_APPLICABLE_CONTEXTS } from './measure-applicable-contexts.js';
5
- export const CORE_MEASURES_MAP = {
6
- [MEASURE.CORE_CPA]: {
7
- title: 'CPA: (Cost Per Acquisition)',
8
- description: 'The amount spent per acquisition. (Total Amount Spent / # Conversions)',
9
- sumPrefix: '$',
10
- sumSuffix: '',
11
- avgPrefix: '$',
12
- avgSuffix: '',
13
- icon: 'upstack',
14
- measure: MEASURE.CORE_CPA,
15
- category: MEASURE_CATEGORY.UPSTACK_DATA,
16
- valueType: MeasureValueType.CURRENCY,
17
- decimalPlaces: 2,
18
- useCompactNotation: true,
19
- applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
20
- },
21
- [MEASURE.CORE_NEW_CUSTOMER_CPA]: {
22
- title: 'NCPA: (New Customer Cost Per Acquisition)',
23
- description: 'The amount spent per new customer acquisition. (Total Amount Spent / # New Customer Conversions)',
24
- sumPrefix: '$',
25
- sumSuffix: '',
26
- avgPrefix: '$',
27
- avgSuffix: '',
28
- icon: 'upstack',
29
- measure: MEASURE.CORE_NEW_CUSTOMER_CPA,
30
- category: MEASURE_CATEGORY.UPSTACK_DATA,
31
- valueType: MeasureValueType.CURRENCY,
32
- decimalPlaces: 2,
33
- useCompactNotation: true,
34
- applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
35
- },
36
- [MEASURE.CORE_RETURNING_CUSTOMER_CPA]: {
37
- title: 'RCPA: (Returning Customer Cost Per Acquisition)',
38
- description: 'The amount spent per returning customer acquisition. (Total Amount Spent / # Returning Customer Conversions)',
39
- sumPrefix: '$',
40
- sumSuffix: '',
41
- avgPrefix: '$',
42
- avgSuffix: '',
43
- icon: 'upstack',
44
- measure: MEASURE.CORE_RETURNING_CUSTOMER_CPA,
45
- category: MEASURE_CATEGORY.UPSTACK_DATA,
46
- valueType: MeasureValueType.CURRENCY,
47
- decimalPlaces: 2,
48
- useCompactNotation: true,
49
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
50
- },
51
- [MEASURE.CORE_MER]: {
52
- title: 'MER (Marketing Efficiency Ratio)',
53
- description: 'Marketing Efficiency Ratio using Total Revenue. (Total Ad Spend / Total Revenue) * 100',
54
- sumPrefix: '',
55
- sumSuffix: '%',
56
- avgPrefix: '',
57
- avgSuffix: '%',
58
- icon: 'upstack',
59
- measure: MEASURE.CORE_MER,
60
- category: MEASURE_CATEGORY.UPSTACK_DATA,
61
- valueType: MeasureValueType.PERCENTAGE,
62
- decimalPlaces: 2,
63
- useCompactNotation: false,
64
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
65
- },
66
- [MEASURE.CORE_MER_NET]: {
67
- title: 'MER (Net Sales): Marketing Efficiency Ratio using Net Sales',
68
- description: 'Marketing Efficiency Ratio using Net Sales. (Total Ad Spend / Net Sales) * 100',
69
- sumPrefix: '',
70
- sumSuffix: '%',
71
- avgPrefix: '',
72
- avgSuffix: '%',
73
- icon: 'upstack',
74
- measure: MEASURE.CORE_MER_NET,
75
- category: MEASURE_CATEGORY.UPSTACK_DATA,
76
- valueType: MeasureValueType.PERCENTAGE,
77
- decimalPlaces: 2,
78
- useCompactNotation: false,
79
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
80
- },
81
- [MEASURE.CORE_MER_GROSS]: {
82
- title: 'MER (Gross Sales): Marketing Efficiency Ratio using Gross Sales',
83
- description: 'Marketing Efficiency Ratio using Gross Sales. (Total Ad Spend / Gross Sales) * 100',
84
- sumPrefix: '',
85
- sumSuffix: '%',
86
- avgPrefix: '',
87
- avgSuffix: '%',
88
- icon: 'upstack',
89
- measure: MEASURE.CORE_MER_GROSS,
90
- category: MEASURE_CATEGORY.UPSTACK_DATA,
91
- valueType: MeasureValueType.PERCENTAGE,
92
- decimalPlaces: 2,
93
- useCompactNotation: false,
94
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
95
- },
96
- [MEASURE.CORE_ROAS_TOTAL]: {
97
- title: 'ROAS (Revenue): Return on Ad Spend using Total Sales',
98
- description: 'Total Revenue / Total Ad Spend',
99
- sumPrefix: '',
100
- sumSuffix: 'x',
101
- avgPrefix: '',
102
- avgSuffix: 'x',
103
- icon: 'upstack',
104
- measure: MEASURE.CORE_ROAS_TOTAL,
105
- category: MEASURE_CATEGORY.UPSTACK_DATA,
106
- valueType: MeasureValueType.MULTIPLIER,
107
- decimalPlaces: 2,
108
- useCompactNotation: false,
109
- applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
110
- aliases: [MEASURE.CORE_ROAS]
111
- },
112
- [MEASURE.CORE_ROAS_GROSS]: {
113
- title: 'ROAS (Gross Sales): Return on Ad Spend using Gross Sales',
114
- description: 'Gross Sales / Total Ad Spend',
115
- sumPrefix: '',
116
- sumSuffix: 'x',
117
- avgPrefix: '',
118
- avgSuffix: 'x',
119
- icon: 'upstack',
120
- measure: MEASURE.CORE_ROAS_GROSS,
121
- category: MEASURE_CATEGORY.UPSTACK_DATA,
122
- valueType: MeasureValueType.MULTIPLIER,
123
- decimalPlaces: 2,
124
- useCompactNotation: false,
125
- applicableContexts: STANDARD_APPLICABLE_CONTEXTS
126
- },
127
- [MEASURE.CORE_ROAS_NET]: {
128
- title: 'ROAS (Net Sales): Return on Ad Spend using Net Sales',
129
- description: 'Net Sales / Total Ad Spend',
130
- sumPrefix: '',
131
- sumSuffix: 'x',
132
- avgPrefix: '',
133
- avgSuffix: 'x',
134
- icon: 'upstack',
135
- measure: MEASURE.CORE_ROAS_NET,
136
- category: MEASURE_CATEGORY.UPSTACK_DATA,
137
- valueType: MeasureValueType.MULTIPLIER,
138
- decimalPlaces: 2,
139
- useCompactNotation: false,
140
- applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
141
- },
142
- [MEASURE.CORE_SPEND_GROSS_PERCENT]: {
143
- title: 'Ad Spend as a percentage of Gross Sales',
144
- description: 'The percentage of gross sales that were spent on ads. (Amount Spent / Gross Sales) * 100',
145
- sumPrefix: '',
146
- sumSuffix: '%',
147
- avgPrefix: '',
148
- avgSuffix: '%',
149
- icon: 'upstack',
150
- measure: MEASURE.CORE_SPEND_GROSS_PERCENT,
151
- category: MEASURE_CATEGORY.UPSTACK_DATA,
152
- valueType: MeasureValueType.PERCENTAGE,
153
- decimalPlaces: 2,
154
- useCompactNotation: false,
155
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
156
- },
157
- [MEASURE.CORE_SPEND_NET_PERCENT]: {
158
- title: 'Ad Spend % of Net Sales',
159
- description: 'The percentage of net sales that were spent on ads. (Amount Spent / Net Sales) * 100',
160
- sumPrefix: '',
161
- sumSuffix: '%',
162
- avgPrefix: '',
163
- avgSuffix: '%',
164
- icon: 'upstack',
165
- measure: MEASURE.CORE_SPEND_NET_PERCENT,
166
- category: MEASURE_CATEGORY.UPSTACK_DATA,
167
- valueType: MeasureValueType.PERCENTAGE,
168
- decimalPlaces: 2,
169
- useCompactNotation: false,
170
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
171
- },
172
- [MEASURE.CORE_RAAD]: {
173
- title: 'RAAD - (Revenue after Discounts, Returns, Ad Spend)',
174
- description: 'Total Revenue - Ad Spend',
175
- sumPrefix: '$',
176
- sumSuffix: '',
177
- avgPrefix: '$',
178
- avgSuffix: '',
179
- icon: 'upstack',
180
- measure: MEASURE.CORE_RAAD,
181
- category: MEASURE_CATEGORY.UPSTACK_DATA,
182
- valueType: MeasureValueType.CURRENCY,
183
- decimalPlaces: 2,
184
- useCompactNotation: true,
185
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
186
- },
187
- [MEASURE.CORE_RAAD_GROSS]: {
188
- title: 'RAAD (Gross Sales): Revenue after Discounts, Returns, Ad Spend',
189
- description: 'Gross Sales - Ad Spend',
190
- sumPrefix: '$',
191
- sumSuffix: '',
192
- avgPrefix: '$',
193
- avgSuffix: '',
194
- icon: 'upstack',
195
- measure: MEASURE.CORE_RAAD_GROSS,
196
- category: MEASURE_CATEGORY.UPSTACK_DATA,
197
- valueType: MeasureValueType.CURRENCY,
198
- decimalPlaces: 2,
199
- useCompactNotation: true,
200
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
201
- },
202
- [MEASURE.CORE_RAAD_NET]: {
203
- title: 'RAAD (Net Sales): Revenue after Discounts, Returns, Ad Spend',
204
- description: 'Net Sales - Ad Spend',
205
- sumPrefix: '$',
206
- sumSuffix: '',
207
- avgPrefix: '$',
208
- avgSuffix: '',
209
- icon: 'upstack',
210
- measure: MEASURE.CORE_RAAD_NET,
211
- category: MEASURE_CATEGORY.UPSTACK_DATA,
212
- valueType: MeasureValueType.CURRENCY,
213
- decimalPlaces: 2,
214
- useCompactNotation: true,
215
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
216
- },
217
- [MEASURE.CORE_RAAD_TOTAL_PERCENT]: {
218
- title: 'RAAD % of Total',
219
- description: 'RAAD as a percentage of Total Revenue. (RAAD / Total Revenue) * 100',
220
- sumPrefix: '',
221
- sumSuffix: '%',
222
- avgPrefix: '',
223
- avgSuffix: '%',
224
- icon: 'upstack',
225
- measure: MEASURE.CORE_RAAD_TOTAL_PERCENT,
226
- category: MEASURE_CATEGORY.UPSTACK_DATA,
227
- valueType: MeasureValueType.PERCENTAGE,
228
- decimalPlaces: 2,
229
- useCompactNotation: false,
230
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
231
- },
232
- [MEASURE.CORE_RAAD_GROSS_PERCENT]: {
233
- title: 'RAAD % of Gross',
234
- description: 'RAAD as a percentage of Gross Sales. (RAAD / Gross Sales) * 100',
235
- sumPrefix: '',
236
- sumSuffix: '%',
237
- avgPrefix: '',
238
- avgSuffix: '%',
239
- icon: 'upstack',
240
- measure: MEASURE.CORE_RAAD_GROSS_PERCENT,
241
- category: MEASURE_CATEGORY.UPSTACK_DATA,
242
- valueType: MeasureValueType.PERCENTAGE,
243
- decimalPlaces: 2,
244
- useCompactNotation: false,
245
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
246
- },
247
- [MEASURE.CORE_RAAD_NET_PERCENT]: {
248
- title: 'RAAD % of Net',
249
- description: 'RAAD as a percentage of Net Sales. (RAAD / Net Sales) * 100',
250
- sumPrefix: '',
251
- sumSuffix: '%',
252
- avgPrefix: '',
253
- avgSuffix: '%',
254
- icon: 'upstack',
255
- measure: MEASURE.CORE_RAAD_NET_PERCENT,
256
- category: MEASURE_CATEGORY.UPSTACK_DATA,
257
- valueType: MeasureValueType.PERCENTAGE,
258
- decimalPlaces: 2,
259
- useCompactNotation: false,
260
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
261
- },
262
- [MEASURE.CORE_NEW_CUSTOMER_RAAD]: {
263
- title: 'NC-RAAD - (Revenue after Discounts, Returns, Ad Spend)',
264
- description: 'Total Revenue - New Customer Ad Spend',
265
- sumPrefix: '$',
266
- sumSuffix: '',
267
- avgPrefix: '$',
268
- avgSuffix: '',
269
- icon: 'upstack',
270
- measure: MEASURE.CORE_NEW_CUSTOMER_RAAD,
271
- category: MEASURE_CATEGORY.UPSTACK_DATA,
272
- valueType: MeasureValueType.CURRENCY,
273
- decimalPlaces: 2,
274
- useCompactNotation: true,
275
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
276
- },
277
- [MEASURE.CORE_NEW_CUSTOMER_RAAD_GROSS]: {
278
- title: 'NC-RAAD (Gross Sales): Revenue after Discounts, Returns, Ad Spend',
279
- description: 'Gross Sales - New Customer Ad Spend',
280
- sumPrefix: '$',
281
- sumSuffix: '',
282
- avgPrefix: '$',
283
- avgSuffix: '',
284
- icon: 'upstack',
285
- measure: MEASURE.CORE_NEW_CUSTOMER_RAAD_GROSS,
286
- category: MEASURE_CATEGORY.UPSTACK_DATA,
287
- valueType: MeasureValueType.CURRENCY,
288
- decimalPlaces: 2,
289
- useCompactNotation: true,
290
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
291
- },
292
- [MEASURE.CORE_NEW_CUSTOMER_RAAD_NET]: {
293
- title: 'NC-RAAD (Net Sales): Revenue after Discounts, Returns, Ad Spend',
294
- description: 'Net Sales - New Customer Ad Spend',
295
- sumPrefix: '$',
296
- sumSuffix: '',
297
- avgPrefix: '$',
298
- avgSuffix: '',
299
- icon: 'upstack',
300
- measure: MEASURE.CORE_NEW_CUSTOMER_RAAD_NET,
301
- category: MEASURE_CATEGORY.UPSTACK_DATA,
302
- valueType: MeasureValueType.CURRENCY,
303
- decimalPlaces: 2,
304
- useCompactNotation: true,
305
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
306
- },
307
- [MEASURE.CORE_NEW_CUSTOMER_RAAD_TOTAL_PERCENT]: {
308
- title: 'NC-RAAD % of Total',
309
- description: 'NC-RAAD as a percentage of Total Revenue. (NC-RAAD / Total Revenue) * 100',
310
- sumPrefix: '',
311
- sumSuffix: '%',
312
- avgPrefix: '',
313
- avgSuffix: '%',
314
- icon: 'upstack',
315
- measure: MEASURE.CORE_NEW_CUSTOMER_RAAD_TOTAL_PERCENT,
316
- category: MEASURE_CATEGORY.UPSTACK_DATA,
317
- valueType: MeasureValueType.PERCENTAGE,
318
- decimalPlaces: 2,
319
- useCompactNotation: false,
320
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
321
- },
322
- [MEASURE.CORE_NEW_CUSTOMER_RAAD_GROSS_PERCENT]: {
323
- title: 'NC-RAAD % of Gross',
324
- description: 'NC-RAAD as a percentage of Gross Sales. (NC-RAAD / Gross Sales) * 100',
325
- sumPrefix: '',
326
- sumSuffix: '%',
327
- avgPrefix: '',
328
- avgSuffix: '%',
329
- icon: 'upstack',
330
- measure: MEASURE.CORE_NEW_CUSTOMER_RAAD_GROSS_PERCENT,
331
- category: MEASURE_CATEGORY.UPSTACK_DATA,
332
- valueType: MeasureValueType.PERCENTAGE,
333
- decimalPlaces: 2,
334
- useCompactNotation: false,
335
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
336
- },
337
- [MEASURE.CORE_NEW_CUSTOMER_RAAD_NET_PERCENT]: {
338
- title: 'NC-RAAD % of Net',
339
- description: 'NC-RAAD as a percentage of Net Sales. (NC-RAAD / Net Sales) * 100',
340
- sumPrefix: '',
341
- sumSuffix: '%',
342
- avgPrefix: '',
343
- avgSuffix: '%',
344
- icon: 'upstack',
345
- measure: MEASURE.CORE_NEW_CUSTOMER_RAAD_NET_PERCENT,
346
- category: MEASURE_CATEGORY.UPSTACK_DATA,
347
- valueType: MeasureValueType.PERCENTAGE,
348
- decimalPlaces: 2,
349
- useCompactNotation: false,
350
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
351
- },
352
- [MEASURE.CORE_NEW_CUSTOMER_ROAS_TOTAL]: {
353
- title: 'NC-ROAS (New Customer Return On Ad Spend)',
354
- description: '(New Customer Revenue / Ad Spend)',
355
- sumPrefix: '',
356
- sumSuffix: 'x',
357
- avgPrefix: '',
358
- avgSuffix: 'x',
359
- icon: 'upstack',
360
- measure: MEASURE.CORE_NEW_CUSTOMER_ROAS_TOTAL,
361
- category: MEASURE_CATEGORY.UPSTACK_DATA,
362
- valueType: MeasureValueType.MULTIPLIER,
363
- decimalPlaces: 2,
364
- useCompactNotation: false,
365
- applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
366
- aliases: [MEASURE.CORE_NEW_CUSTOMER_ROAS]
367
- },
368
- [MEASURE.CORE_NEW_CUSTOMER_ROAS_GROSS]: {
369
- title: 'NC-ROAS GROSS (New Customer Return On Ad Spend)',
370
- description: '(New Customer Gross Sales / Ad Spend)',
371
- sumPrefix: '',
372
- sumSuffix: 'x',
373
- avgPrefix: '',
374
- avgSuffix: 'x',
375
- icon: 'upstack',
376
- measure: MEASURE.CORE_NEW_CUSTOMER_ROAS_GROSS,
377
- category: MEASURE_CATEGORY.UPSTACK_DATA,
378
- valueType: MeasureValueType.MULTIPLIER,
379
- decimalPlaces: 2,
380
- useCompactNotation: false,
381
- applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
382
- },
383
- [MEASURE.CORE_NEW_CUSTOMER_ROAS_NET]: {
384
- title: 'NC-ROAS NET (New Customer Return On Ad Spend)',
385
- description: '(New Customer Net Sales / Ad Spend)',
386
- sumPrefix: '',
387
- sumSuffix: 'x',
388
- avgPrefix: '',
389
- avgSuffix: 'x',
390
- icon: 'upstack',
391
- measure: MEASURE.CORE_NEW_CUSTOMER_ROAS_NET,
392
- category: MEASURE_CATEGORY.UPSTACK_DATA,
393
- valueType: MeasureValueType.MULTIPLIER,
394
- decimalPlaces: 2,
395
- useCompactNotation: false,
396
- applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
397
- },
398
- [MEASURE.CORE_NEW_CUSTOMER_MER]: {
399
- title: 'NC-MER (New Customer Marketing Efficiency Ratio)',
400
- description: 'Marketing Efficiency Ratio using Total Revenue. (Total Ad Spend / New Customer Revenue)',
401
- sumPrefix: '',
402
- sumSuffix: '%',
403
- avgPrefix: '',
404
- avgSuffix: '%',
405
- icon: 'upstack',
406
- measure: MEASURE.CORE_NEW_CUSTOMER_MER,
407
- category: MEASURE_CATEGORY.UPSTACK_DATA,
408
- valueType: MeasureValueType.PERCENTAGE,
409
- decimalPlaces: 2,
410
- useCompactNotation: false,
411
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
412
- },
413
- [MEASURE.CORE_NEW_CUSTOMER_MER_GROSS]: {
414
- title: 'NC-MER GROSS (New Customer Marketing Efficiency Ratio)',
415
- description: 'Marketing Efficiency Ratio using Gross Sales. (Total Ad Spend / New Customer Gross Sales)',
416
- sumPrefix: '',
417
- sumSuffix: '%',
418
- avgPrefix: '',
419
- avgSuffix: '%',
420
- icon: 'upstack',
421
- measure: MEASURE.CORE_NEW_CUSTOMER_MER_GROSS,
422
- category: MEASURE_CATEGORY.UPSTACK_DATA,
423
- valueType: MeasureValueType.PERCENTAGE,
424
- decimalPlaces: 2,
425
- useCompactNotation: false,
426
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
427
- },
428
- [MEASURE.CORE_NEW_CUSTOMER_MER_NET]: {
429
- title: 'NC-MER NET (New Customer Marketing Efficiency Ratio)',
430
- description: 'Marketing Efficiency Ratio using Net Sales. (Total Ad Spend / New Customer Net Sales)',
431
- sumPrefix: '',
432
- sumSuffix: '%',
433
- avgPrefix: '',
434
- avgSuffix: '%',
435
- icon: 'upstack',
436
- measure: MEASURE.CORE_NEW_CUSTOMER_MER_NET,
437
- category: MEASURE_CATEGORY.UPSTACK_DATA,
438
- valueType: MeasureValueType.PERCENTAGE,
439
- decimalPlaces: 2,
440
- useCompactNotation: false,
441
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
442
- }
443
- };
1
+ import { MEASURE } from '../measures.js';
2
+ import { MEASURE_CATEGORY } from './measure-categories.js';
3
+ import { MeasureValueType } from './measure-value-type.js';
4
+ import { CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS, STANDARD_APPLICABLE_CONTEXTS } from './measure-applicable-contexts.js';
5
+ export const CORE_MEASURES_MAP = {
6
+ [MEASURE.CORE_CPA]: {
7
+ title: 'CPA: (Cost Per Acquisition)',
8
+ description: 'The amount spent per acquisition. (Total Amount Spent / # Conversions)',
9
+ sumPrefix: '$',
10
+ sumSuffix: '',
11
+ avgPrefix: '$',
12
+ avgSuffix: '',
13
+ icon: 'upstack',
14
+ measure: MEASURE.CORE_CPA,
15
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
16
+ valueType: MeasureValueType.CURRENCY,
17
+ decimalPlaces: 2,
18
+ useCompactNotation: true,
19
+ applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
20
+ },
21
+ [MEASURE.CORE_NEW_CUSTOMER_CPA]: {
22
+ title: 'NCPA: (New Customer Cost Per Acquisition)',
23
+ description: 'The amount spent per new customer acquisition. (Total Amount Spent / # New Customer Conversions)',
24
+ sumPrefix: '$',
25
+ sumSuffix: '',
26
+ avgPrefix: '$',
27
+ avgSuffix: '',
28
+ icon: 'upstack',
29
+ measure: MEASURE.CORE_NEW_CUSTOMER_CPA,
30
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
31
+ valueType: MeasureValueType.CURRENCY,
32
+ decimalPlaces: 2,
33
+ useCompactNotation: true,
34
+ applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
35
+ },
36
+ [MEASURE.CORE_RETURNING_CUSTOMER_CPA]: {
37
+ title: 'RCPA: (Returning Customer Cost Per Acquisition)',
38
+ description: 'The amount spent per returning customer acquisition. (Total Amount Spent / # Returning Customer Conversions)',
39
+ sumPrefix: '$',
40
+ sumSuffix: '',
41
+ avgPrefix: '$',
42
+ avgSuffix: '',
43
+ icon: 'upstack',
44
+ measure: MEASURE.CORE_RETURNING_CUSTOMER_CPA,
45
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
46
+ valueType: MeasureValueType.CURRENCY,
47
+ decimalPlaces: 2,
48
+ useCompactNotation: true,
49
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
50
+ },
51
+ [MEASURE.CORE_MER]: {
52
+ title: 'MER (Marketing Efficiency Ratio)',
53
+ description: 'Marketing Efficiency Ratio using Total Revenue. (Total Ad Spend / Total Revenue) * 100',
54
+ sumPrefix: '',
55
+ sumSuffix: '%',
56
+ avgPrefix: '',
57
+ avgSuffix: '%',
58
+ icon: 'upstack',
59
+ measure: MEASURE.CORE_MER,
60
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
61
+ valueType: MeasureValueType.PERCENTAGE,
62
+ decimalPlaces: 2,
63
+ useCompactNotation: false,
64
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
65
+ },
66
+ [MEASURE.CORE_MER_NET]: {
67
+ title: 'MER (Net Sales): Marketing Efficiency Ratio using Net Sales',
68
+ description: 'Marketing Efficiency Ratio using Net Sales. (Total Ad Spend / Net Sales) * 100',
69
+ sumPrefix: '',
70
+ sumSuffix: '%',
71
+ avgPrefix: '',
72
+ avgSuffix: '%',
73
+ icon: 'upstack',
74
+ measure: MEASURE.CORE_MER_NET,
75
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
76
+ valueType: MeasureValueType.PERCENTAGE,
77
+ decimalPlaces: 2,
78
+ useCompactNotation: false,
79
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
80
+ },
81
+ [MEASURE.CORE_MER_GROSS]: {
82
+ title: 'MER (Gross Sales): Marketing Efficiency Ratio using Gross Sales',
83
+ description: 'Marketing Efficiency Ratio using Gross Sales. (Total Ad Spend / Gross Sales) * 100',
84
+ sumPrefix: '',
85
+ sumSuffix: '%',
86
+ avgPrefix: '',
87
+ avgSuffix: '%',
88
+ icon: 'upstack',
89
+ measure: MEASURE.CORE_MER_GROSS,
90
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
91
+ valueType: MeasureValueType.PERCENTAGE,
92
+ decimalPlaces: 2,
93
+ useCompactNotation: false,
94
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
95
+ },
96
+ [MEASURE.CORE_ROAS_TOTAL]: {
97
+ title: 'ROAS (Revenue): Return on Ad Spend using Total Sales',
98
+ description: 'Total Revenue / Total Ad Spend',
99
+ sumPrefix: '',
100
+ sumSuffix: 'x',
101
+ avgPrefix: '',
102
+ avgSuffix: 'x',
103
+ icon: 'upstack',
104
+ measure: MEASURE.CORE_ROAS_TOTAL,
105
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
106
+ valueType: MeasureValueType.MULTIPLIER,
107
+ decimalPlaces: 2,
108
+ useCompactNotation: false,
109
+ applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
110
+ aliases: [MEASURE.CORE_ROAS]
111
+ },
112
+ [MEASURE.CORE_ROAS_GROSS]: {
113
+ title: 'ROAS (Gross Sales): Return on Ad Spend using Gross Sales',
114
+ description: 'Gross Sales / Total Ad Spend',
115
+ sumPrefix: '',
116
+ sumSuffix: 'x',
117
+ avgPrefix: '',
118
+ avgSuffix: 'x',
119
+ icon: 'upstack',
120
+ measure: MEASURE.CORE_ROAS_GROSS,
121
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
122
+ valueType: MeasureValueType.MULTIPLIER,
123
+ decimalPlaces: 2,
124
+ useCompactNotation: false,
125
+ applicableContexts: STANDARD_APPLICABLE_CONTEXTS
126
+ },
127
+ [MEASURE.CORE_ROAS_NET]: {
128
+ title: 'ROAS (Net Sales): Return on Ad Spend using Net Sales',
129
+ description: 'Net Sales / Total Ad Spend',
130
+ sumPrefix: '',
131
+ sumSuffix: 'x',
132
+ avgPrefix: '',
133
+ avgSuffix: 'x',
134
+ icon: 'upstack',
135
+ measure: MEASURE.CORE_ROAS_NET,
136
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
137
+ valueType: MeasureValueType.MULTIPLIER,
138
+ decimalPlaces: 2,
139
+ useCompactNotation: false,
140
+ applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
141
+ },
142
+ [MEASURE.CORE_SPEND_GROSS_PERCENT]: {
143
+ title: 'Ad Spend as a percentage of Gross Sales',
144
+ description: 'The percentage of gross sales that were spent on ads. (Amount Spent / Gross Sales) * 100',
145
+ sumPrefix: '',
146
+ sumSuffix: '%',
147
+ avgPrefix: '',
148
+ avgSuffix: '%',
149
+ icon: 'upstack',
150
+ measure: MEASURE.CORE_SPEND_GROSS_PERCENT,
151
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
152
+ valueType: MeasureValueType.PERCENTAGE,
153
+ decimalPlaces: 2,
154
+ useCompactNotation: false,
155
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
156
+ },
157
+ [MEASURE.CORE_SPEND_NET_PERCENT]: {
158
+ title: 'Ad Spend % of Net Sales',
159
+ description: 'The percentage of net sales that were spent on ads. (Amount Spent / Net Sales) * 100',
160
+ sumPrefix: '',
161
+ sumSuffix: '%',
162
+ avgPrefix: '',
163
+ avgSuffix: '%',
164
+ icon: 'upstack',
165
+ measure: MEASURE.CORE_SPEND_NET_PERCENT,
166
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
167
+ valueType: MeasureValueType.PERCENTAGE,
168
+ decimalPlaces: 2,
169
+ useCompactNotation: false,
170
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
171
+ },
172
+ [MEASURE.CORE_RAAD]: {
173
+ title: 'RAAD - (Revenue after Discounts, Returns, Ad Spend)',
174
+ description: 'Total Revenue - Ad Spend',
175
+ sumPrefix: '$',
176
+ sumSuffix: '',
177
+ avgPrefix: '$',
178
+ avgSuffix: '',
179
+ icon: 'upstack',
180
+ measure: MEASURE.CORE_RAAD,
181
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
182
+ valueType: MeasureValueType.CURRENCY,
183
+ decimalPlaces: 2,
184
+ useCompactNotation: true,
185
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
186
+ },
187
+ [MEASURE.CORE_RAAD_GROSS]: {
188
+ title: 'RAAD (Gross Sales): Revenue after Discounts, Returns, Ad Spend',
189
+ description: 'Gross Sales - Ad Spend',
190
+ sumPrefix: '$',
191
+ sumSuffix: '',
192
+ avgPrefix: '$',
193
+ avgSuffix: '',
194
+ icon: 'upstack',
195
+ measure: MEASURE.CORE_RAAD_GROSS,
196
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
197
+ valueType: MeasureValueType.CURRENCY,
198
+ decimalPlaces: 2,
199
+ useCompactNotation: true,
200
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
201
+ },
202
+ [MEASURE.CORE_RAAD_NET]: {
203
+ title: 'RAAD (Net Sales): Revenue after Discounts, Returns, Ad Spend',
204
+ description: 'Net Sales - Ad Spend',
205
+ sumPrefix: '$',
206
+ sumSuffix: '',
207
+ avgPrefix: '$',
208
+ avgSuffix: '',
209
+ icon: 'upstack',
210
+ measure: MEASURE.CORE_RAAD_NET,
211
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
212
+ valueType: MeasureValueType.CURRENCY,
213
+ decimalPlaces: 2,
214
+ useCompactNotation: true,
215
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
216
+ },
217
+ [MEASURE.CORE_RAAD_TOTAL_PERCENT]: {
218
+ title: 'RAAD % of Total',
219
+ description: 'RAAD as a percentage of Total Revenue. (RAAD / Total Revenue) * 100',
220
+ sumPrefix: '',
221
+ sumSuffix: '%',
222
+ avgPrefix: '',
223
+ avgSuffix: '%',
224
+ icon: 'upstack',
225
+ measure: MEASURE.CORE_RAAD_TOTAL_PERCENT,
226
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
227
+ valueType: MeasureValueType.PERCENTAGE,
228
+ decimalPlaces: 2,
229
+ useCompactNotation: false,
230
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
231
+ },
232
+ [MEASURE.CORE_RAAD_GROSS_PERCENT]: {
233
+ title: 'RAAD % of Gross',
234
+ description: 'RAAD as a percentage of Gross Sales. (RAAD / Gross Sales) * 100',
235
+ sumPrefix: '',
236
+ sumSuffix: '%',
237
+ avgPrefix: '',
238
+ avgSuffix: '%',
239
+ icon: 'upstack',
240
+ measure: MEASURE.CORE_RAAD_GROSS_PERCENT,
241
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
242
+ valueType: MeasureValueType.PERCENTAGE,
243
+ decimalPlaces: 2,
244
+ useCompactNotation: false,
245
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
246
+ },
247
+ [MEASURE.CORE_RAAD_NET_PERCENT]: {
248
+ title: 'RAAD % of Net',
249
+ description: 'RAAD as a percentage of Net Sales. (RAAD / Net Sales) * 100',
250
+ sumPrefix: '',
251
+ sumSuffix: '%',
252
+ avgPrefix: '',
253
+ avgSuffix: '%',
254
+ icon: 'upstack',
255
+ measure: MEASURE.CORE_RAAD_NET_PERCENT,
256
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
257
+ valueType: MeasureValueType.PERCENTAGE,
258
+ decimalPlaces: 2,
259
+ useCompactNotation: false,
260
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
261
+ },
262
+ [MEASURE.CORE_NEW_CUSTOMER_RAAD]: {
263
+ title: 'NC-RAAD - (Revenue after Discounts, Returns, Ad Spend)',
264
+ description: 'Total Revenue - New Customer Ad Spend',
265
+ sumPrefix: '$',
266
+ sumSuffix: '',
267
+ avgPrefix: '$',
268
+ avgSuffix: '',
269
+ icon: 'upstack',
270
+ measure: MEASURE.CORE_NEW_CUSTOMER_RAAD,
271
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
272
+ valueType: MeasureValueType.CURRENCY,
273
+ decimalPlaces: 2,
274
+ useCompactNotation: true,
275
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
276
+ },
277
+ [MEASURE.CORE_NEW_CUSTOMER_RAAD_GROSS]: {
278
+ title: 'NC-RAAD (Gross Sales): Revenue after Discounts, Returns, Ad Spend',
279
+ description: 'Gross Sales - New Customer Ad Spend',
280
+ sumPrefix: '$',
281
+ sumSuffix: '',
282
+ avgPrefix: '$',
283
+ avgSuffix: '',
284
+ icon: 'upstack',
285
+ measure: MEASURE.CORE_NEW_CUSTOMER_RAAD_GROSS,
286
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
287
+ valueType: MeasureValueType.CURRENCY,
288
+ decimalPlaces: 2,
289
+ useCompactNotation: true,
290
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
291
+ },
292
+ [MEASURE.CORE_NEW_CUSTOMER_RAAD_NET]: {
293
+ title: 'NC-RAAD (Net Sales): Revenue after Discounts, Returns, Ad Spend',
294
+ description: 'Net Sales - New Customer Ad Spend',
295
+ sumPrefix: '$',
296
+ sumSuffix: '',
297
+ avgPrefix: '$',
298
+ avgSuffix: '',
299
+ icon: 'upstack',
300
+ measure: MEASURE.CORE_NEW_CUSTOMER_RAAD_NET,
301
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
302
+ valueType: MeasureValueType.CURRENCY,
303
+ decimalPlaces: 2,
304
+ useCompactNotation: true,
305
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
306
+ },
307
+ [MEASURE.CORE_NEW_CUSTOMER_RAAD_TOTAL_PERCENT]: {
308
+ title: 'NC-RAAD % of Total',
309
+ description: 'NC-RAAD as a percentage of Total Revenue. (NC-RAAD / Total Revenue) * 100',
310
+ sumPrefix: '',
311
+ sumSuffix: '%',
312
+ avgPrefix: '',
313
+ avgSuffix: '%',
314
+ icon: 'upstack',
315
+ measure: MEASURE.CORE_NEW_CUSTOMER_RAAD_TOTAL_PERCENT,
316
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
317
+ valueType: MeasureValueType.PERCENTAGE,
318
+ decimalPlaces: 2,
319
+ useCompactNotation: false,
320
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
321
+ },
322
+ [MEASURE.CORE_NEW_CUSTOMER_RAAD_GROSS_PERCENT]: {
323
+ title: 'NC-RAAD % of Gross',
324
+ description: 'NC-RAAD as a percentage of Gross Sales. (NC-RAAD / Gross Sales) * 100',
325
+ sumPrefix: '',
326
+ sumSuffix: '%',
327
+ avgPrefix: '',
328
+ avgSuffix: '%',
329
+ icon: 'upstack',
330
+ measure: MEASURE.CORE_NEW_CUSTOMER_RAAD_GROSS_PERCENT,
331
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
332
+ valueType: MeasureValueType.PERCENTAGE,
333
+ decimalPlaces: 2,
334
+ useCompactNotation: false,
335
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
336
+ },
337
+ [MEASURE.CORE_NEW_CUSTOMER_RAAD_NET_PERCENT]: {
338
+ title: 'NC-RAAD % of Net',
339
+ description: 'NC-RAAD as a percentage of Net Sales. (NC-RAAD / Net Sales) * 100',
340
+ sumPrefix: '',
341
+ sumSuffix: '%',
342
+ avgPrefix: '',
343
+ avgSuffix: '%',
344
+ icon: 'upstack',
345
+ measure: MEASURE.CORE_NEW_CUSTOMER_RAAD_NET_PERCENT,
346
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
347
+ valueType: MeasureValueType.PERCENTAGE,
348
+ decimalPlaces: 2,
349
+ useCompactNotation: false,
350
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
351
+ },
352
+ [MEASURE.CORE_NEW_CUSTOMER_ROAS_TOTAL]: {
353
+ title: 'NC-ROAS (New Customer Return On Ad Spend)',
354
+ description: '(New Customer Revenue / Ad Spend)',
355
+ sumPrefix: '',
356
+ sumSuffix: 'x',
357
+ avgPrefix: '',
358
+ avgSuffix: 'x',
359
+ icon: 'upstack',
360
+ measure: MEASURE.CORE_NEW_CUSTOMER_ROAS_TOTAL,
361
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
362
+ valueType: MeasureValueType.MULTIPLIER,
363
+ decimalPlaces: 2,
364
+ useCompactNotation: false,
365
+ applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
366
+ aliases: [MEASURE.CORE_NEW_CUSTOMER_ROAS]
367
+ },
368
+ [MEASURE.CORE_NEW_CUSTOMER_ROAS_GROSS]: {
369
+ title: 'NC-ROAS GROSS (New Customer Return On Ad Spend)',
370
+ description: '(New Customer Gross Sales / Ad Spend)',
371
+ sumPrefix: '',
372
+ sumSuffix: 'x',
373
+ avgPrefix: '',
374
+ avgSuffix: 'x',
375
+ icon: 'upstack',
376
+ measure: MEASURE.CORE_NEW_CUSTOMER_ROAS_GROSS,
377
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
378
+ valueType: MeasureValueType.MULTIPLIER,
379
+ decimalPlaces: 2,
380
+ useCompactNotation: false,
381
+ applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
382
+ },
383
+ [MEASURE.CORE_NEW_CUSTOMER_ROAS_NET]: {
384
+ title: 'NC-ROAS NET (New Customer Return On Ad Spend)',
385
+ description: '(New Customer Net Sales / Ad Spend)',
386
+ sumPrefix: '',
387
+ sumSuffix: 'x',
388
+ avgPrefix: '',
389
+ avgSuffix: 'x',
390
+ icon: 'upstack',
391
+ measure: MEASURE.CORE_NEW_CUSTOMER_ROAS_NET,
392
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
393
+ valueType: MeasureValueType.MULTIPLIER,
394
+ decimalPlaces: 2,
395
+ useCompactNotation: false,
396
+ applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
397
+ },
398
+ [MEASURE.CORE_NEW_CUSTOMER_MER]: {
399
+ title: 'NC-MER (New Customer Marketing Efficiency Ratio)',
400
+ description: 'Marketing Efficiency Ratio using Total Revenue. (Total Ad Spend / New Customer Revenue)',
401
+ sumPrefix: '',
402
+ sumSuffix: '%',
403
+ avgPrefix: '',
404
+ avgSuffix: '%',
405
+ icon: 'upstack',
406
+ measure: MEASURE.CORE_NEW_CUSTOMER_MER,
407
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
408
+ valueType: MeasureValueType.PERCENTAGE,
409
+ decimalPlaces: 2,
410
+ useCompactNotation: false,
411
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
412
+ },
413
+ [MEASURE.CORE_NEW_CUSTOMER_MER_GROSS]: {
414
+ title: 'NC-MER GROSS (New Customer Marketing Efficiency Ratio)',
415
+ description: 'Marketing Efficiency Ratio using Gross Sales. (Total Ad Spend / New Customer Gross Sales)',
416
+ sumPrefix: '',
417
+ sumSuffix: '%',
418
+ avgPrefix: '',
419
+ avgSuffix: '%',
420
+ icon: 'upstack',
421
+ measure: MEASURE.CORE_NEW_CUSTOMER_MER_GROSS,
422
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
423
+ valueType: MeasureValueType.PERCENTAGE,
424
+ decimalPlaces: 2,
425
+ useCompactNotation: false,
426
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
427
+ },
428
+ [MEASURE.CORE_NEW_CUSTOMER_MER_NET]: {
429
+ title: 'NC-MER NET (New Customer Marketing Efficiency Ratio)',
430
+ description: 'Marketing Efficiency Ratio using Net Sales. (Total Ad Spend / New Customer Net Sales)',
431
+ sumPrefix: '',
432
+ sumSuffix: '%',
433
+ avgPrefix: '',
434
+ avgSuffix: '%',
435
+ icon: 'upstack',
436
+ measure: MEASURE.CORE_NEW_CUSTOMER_MER_NET,
437
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
438
+ valueType: MeasureValueType.PERCENTAGE,
439
+ decimalPlaces: 2,
440
+ useCompactNotation: false,
441
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
442
+ }
443
+ };
444
444
  //# sourceMappingURL=core-measure-definitions.js.map