@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,862 +1,862 @@
1
- import { MEASURE } from '../../measures.js';
2
- import { MEASURE_CATEGORY } from '../measure-categories.js';
3
- import { MeasureValueType } from '../measure-value-type.js';
4
- import { SHOPIFY_NEW_CUSTOMER_MEASURES_MAP } from './shopify-nc-measure-definitions.js';
5
- import { SHOPIFY_RETURNING_CUSTOMER_MEASURES_MAP } from './shopify-rc-measure-definitions.js';
6
- import { CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS, STANDARD_APPLICABLE_CONTEXTS, LTV_COHORT_APPLICABLE_CONTEXTS } from '../measure-applicable-contexts.js';
7
- export const SHOPIFY_MEASURES_MAP = {
8
- [MEASURE.SHOPIFY_ORDERS]: {
9
- title: 'Orders',
10
- description: 'The number of orders.',
11
- sumPrefix: '',
12
- sumSuffix: '',
13
- avgPrefix: '',
14
- avgSuffix: '',
15
- icon: 'shopify',
16
- measure: MEASURE.SHOPIFY_ORDERS,
17
- category: MEASURE_CATEGORY.SALES,
18
- valueType: MeasureValueType.NUMBER,
19
- decimalPlaces: 0,
20
- useCompactNotation: false,
21
- applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
22
- },
23
- [MEASURE.SHOPIFY_CUSTOMERS]: {
24
- title: 'Customers',
25
- description: 'The number of customers.',
26
- sumPrefix: '',
27
- sumSuffix: '',
28
- avgPrefix: '',
29
- avgSuffix: '',
30
- icon: 'shopify',
31
- measure: MEASURE.SHOPIFY_CUSTOMERS,
32
- category: MEASURE_CATEGORY.SALES,
33
- valueType: MeasureValueType.NUMBER,
34
- decimalPlaces: 0,
35
- useCompactNotation: false,
36
- applicableContexts: STANDARD_APPLICABLE_CONTEXTS
37
- },
38
- [MEASURE.SHOPIFY_TOTAL_REVENUE]: {
39
- title: 'Total Revenue',
40
- description: 'The total revenue generated.',
41
- sumPrefix: '$',
42
- sumSuffix: '',
43
- avgPrefix: '$',
44
- avgSuffix: '',
45
- icon: 'shopify',
46
- measure: MEASURE.SHOPIFY_TOTAL_REVENUE,
47
- category: MEASURE_CATEGORY.SALES,
48
- valueType: MeasureValueType.CURRENCY,
49
- decimalPlaces: 2,
50
- useCompactNotation: true,
51
- applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
52
- aliases: [MEASURE.SHOPIFY_TOTAL_AMOUNT, MEASURE.SHOPIFY_REVENUE, MEASURE.SHOPIFY_TOTAL_SALES],
53
- },
54
- [MEASURE.SHOPIFY_GROSS_SALES]: {
55
- title: 'Gross Sales',
56
- description: 'Product price * quantity (before taxes, shipping, discounts and returns)',
57
- sumPrefix: '$',
58
- sumSuffix: '',
59
- avgPrefix: '$',
60
- avgSuffix: '',
61
- icon: 'shopify',
62
- measure: MEASURE.SHOPIFY_GROSS_SALES,
63
- category: MEASURE_CATEGORY.SALES,
64
- valueType: MeasureValueType.CURRENCY,
65
- decimalPlaces: 2,
66
- useCompactNotation: true,
67
- applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
68
- },
69
- [MEASURE.SHOPIFY_NET_SALES]: {
70
- title: 'Net Sales',
71
- description: 'Gross Sales - Discounts - Returns',
72
- sumPrefix: '$',
73
- sumSuffix: '',
74
- avgPrefix: '$',
75
- avgSuffix: '',
76
- icon: 'shopify',
77
- measure: MEASURE.SHOPIFY_NET_SALES,
78
- category: MEASURE_CATEGORY.SALES,
79
- valueType: MeasureValueType.CURRENCY,
80
- decimalPlaces: 2,
81
- useCompactNotation: true,
82
- applicableContexts: STANDARD_APPLICABLE_CONTEXTS
83
- },
84
- [MEASURE.SHOPIFY_ABANDONED_CHECKOUTS_VALUE]: {
85
- title: 'Abandoned Checkouts Value',
86
- description: 'The total value of abandoned checkouts.',
87
- sumPrefix: '$',
88
- sumSuffix: '',
89
- avgPrefix: '$',
90
- avgSuffix: '',
91
- icon: 'shopify',
92
- measure: MEASURE.SHOPIFY_ABANDONED_CHECKOUTS_VALUE,
93
- category: MEASURE_CATEGORY.SALES,
94
- valueType: MeasureValueType.CURRENCY,
95
- decimalPlaces: 2,
96
- useCompactNotation: true,
97
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
98
- },
99
- [MEASURE.SHOPIFY_ABANDONED_CHECKOUTS]: {
100
- title: 'Abandoned Checkouts',
101
- description: 'The number of abandoned checkouts.',
102
- sumPrefix: '',
103
- sumSuffix: '',
104
- avgPrefix: '',
105
- avgSuffix: '',
106
- icon: 'shopify',
107
- measure: MEASURE.SHOPIFY_ABANDONED_CHECKOUTS,
108
- category: MEASURE_CATEGORY.SALES,
109
- valueType: MeasureValueType.NUMBER,
110
- decimalPlaces: 0,
111
- useCompactNotation: false,
112
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
113
- },
114
- [MEASURE.SHOPIFY_CANCELLED_ORDERS]: {
115
- title: 'Cancelled Orders',
116
- description: 'The number of cancelled orders.',
117
- sumPrefix: '',
118
- sumSuffix: '',
119
- avgPrefix: '',
120
- avgSuffix: '',
121
- icon: 'shopify',
122
- measure: MEASURE.SHOPIFY_CANCELLED_ORDERS,
123
- category: MEASURE_CATEGORY.SALES,
124
- valueType: MeasureValueType.NUMBER,
125
- decimalPlaces: 0,
126
- useCompactNotation: false,
127
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
128
- },
129
- [MEASURE.SHOPIFY_CANCELLED_AMOUNT]: {
130
- title: 'Cancelled Amount',
131
- description: 'The total amount of cancelled orders.',
132
- sumPrefix: '$',
133
- sumSuffix: '',
134
- avgPrefix: '$',
135
- avgSuffix: '',
136
- icon: 'shopify',
137
- measure: MEASURE.SHOPIFY_CANCELLED_AMOUNT,
138
- category: MEASURE_CATEGORY.SALES,
139
- valueType: MeasureValueType.CURRENCY,
140
- decimalPlaces: 2,
141
- useCompactNotation: true,
142
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
143
- },
144
- [MEASURE.SHOPIFY_REFUNDS]: {
145
- title: 'Refunded Orders',
146
- description: 'The number of orders that were refunded.',
147
- sumPrefix: '',
148
- sumSuffix: '',
149
- avgPrefix: '',
150
- avgSuffix: '',
151
- icon: 'shopify',
152
- measure: MEASURE.SHOPIFY_REFUNDS,
153
- category: MEASURE_CATEGORY.SALES,
154
- valueType: MeasureValueType.NUMBER,
155
- decimalPlaces: 0,
156
- useCompactNotation: false,
157
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
158
- },
159
- [MEASURE.SHOPIFY_REFUND_AMOUNT_REFUND_DATE]: {
160
- title: 'Refund Amount By Date of Refund',
161
- description: 'The total amount of refunds by refund date.',
162
- sumPrefix: '$',
163
- sumSuffix: '',
164
- avgPrefix: '$',
165
- avgSuffix: '',
166
- icon: 'shopify',
167
- measure: MEASURE.SHOPIFY_REFUND_AMOUNT_REFUND_DATE,
168
- category: MEASURE_CATEGORY.SALES,
169
- valueType: MeasureValueType.CURRENCY,
170
- decimalPlaces: 2,
171
- useCompactNotation: true,
172
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
173
- },
174
- [MEASURE.SHOPIFY_REFUND_AMOUNT_ORDER_DATE]: {
175
- title: 'Refund Amount By Date of Order',
176
- description: 'The total amount of refunds by order date.',
177
- sumPrefix: '$',
178
- sumSuffix: '',
179
- avgPrefix: '$',
180
- avgSuffix: '',
181
- icon: 'shopify',
182
- measure: MEASURE.SHOPIFY_REFUND_AMOUNT_ORDER_DATE,
183
- category: MEASURE_CATEGORY.SALES,
184
- valueType: MeasureValueType.CURRENCY,
185
- decimalPlaces: 2,
186
- useCompactNotation: true,
187
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
188
- },
189
- [MEASURE.SHOPIFY_REFUND_GROSS_PERCENT]: {
190
- title: 'Refund Rate (% of Gross Sales)',
191
- description: 'The percentage of gross sales amount that was refunded.',
192
- sumPrefix: '',
193
- sumSuffix: '%',
194
- avgPrefix: '',
195
- avgSuffix: '%',
196
- icon: 'shopify',
197
- measure: MEASURE.SHOPIFY_REFUND_GROSS_PERCENT,
198
- category: MEASURE_CATEGORY.SALES,
199
- valueType: MeasureValueType.PERCENTAGE,
200
- decimalPlaces: 2,
201
- useCompactNotation: false,
202
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
203
- },
204
- [MEASURE.SHOPIFY_REFUND_NET_PERCENT]: {
205
- title: 'Refund Rate (% of Net Sales)',
206
- description: 'The percentage of net sales amount that was refunded.',
207
- sumPrefix: '',
208
- sumSuffix: '%',
209
- avgPrefix: '',
210
- avgSuffix: '%',
211
- icon: 'shopify',
212
- measure: MEASURE.SHOPIFY_REFUND_NET_PERCENT,
213
- category: MEASURE_CATEGORY.SALES,
214
- valueType: MeasureValueType.PERCENTAGE,
215
- decimalPlaces: 2,
216
- useCompactNotation: false,
217
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
218
- },
219
- [MEASURE.SHOPIFY_REFUND_RATE]: {
220
- title: 'Refunded Order Rate',
221
- description: 'The percentage of total orders that were refunded.',
222
- sumPrefix: '',
223
- sumSuffix: '%',
224
- avgPrefix: '',
225
- avgSuffix: '%',
226
- icon: 'shopify',
227
- measure: MEASURE.SHOPIFY_REFUND_RATE,
228
- category: MEASURE_CATEGORY.SALES,
229
- valueType: MeasureValueType.PERCENTAGE,
230
- decimalPlaces: 2,
231
- useCompactNotation: false,
232
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
233
- },
234
- [MEASURE.SHOPIFY_DISCOUNTS]: {
235
- title: 'Discounted Orders',
236
- description: 'The number of orders that were discounted.',
237
- sumPrefix: '',
238
- sumSuffix: '',
239
- avgPrefix: '',
240
- avgSuffix: '',
241
- icon: 'shopify',
242
- measure: MEASURE.SHOPIFY_DISCOUNTS,
243
- category: MEASURE_CATEGORY.SALES,
244
- valueType: MeasureValueType.NUMBER,
245
- decimalPlaces: 0,
246
- useCompactNotation: false,
247
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
248
- },
249
- [MEASURE.SHOPIFY_DISCOUNT_AMOUNT]: {
250
- title: 'Discount Amount',
251
- description: 'The total amount of discounts applied to all orders.',
252
- sumPrefix: '$',
253
- sumSuffix: '',
254
- avgPrefix: '$',
255
- avgSuffix: '',
256
- icon: 'shopify',
257
- measure: MEASURE.SHOPIFY_DISCOUNT_AMOUNT,
258
- category: MEASURE_CATEGORY.SALES,
259
- valueType: MeasureValueType.CURRENCY,
260
- decimalPlaces: 2,
261
- useCompactNotation: true,
262
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
263
- },
264
- [MEASURE.SHOPIFY_DISCOUNT_GROSS_PERCENT]: {
265
- title: 'Discount Rate (% of Gross Sales)',
266
- description: 'The percentage of gross sales amount that was discounted.',
267
- sumPrefix: '',
268
- sumSuffix: '%',
269
- avgPrefix: '',
270
- avgSuffix: '%',
271
- icon: 'shopify',
272
- measure: MEASURE.SHOPIFY_DISCOUNT_GROSS_PERCENT,
273
- category: MEASURE_CATEGORY.SALES,
274
- valueType: MeasureValueType.PERCENTAGE,
275
- decimalPlaces: 2,
276
- useCompactNotation: false,
277
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
278
- },
279
- [MEASURE.SHOPIFY_DISCOUNT_RATE]: {
280
- title: 'Discounted Order Rate',
281
- description: 'The percentage of total orders that were discounted.',
282
- sumPrefix: '',
283
- sumSuffix: '%',
284
- avgPrefix: '',
285
- avgSuffix: '%',
286
- icon: 'shopify',
287
- measure: MEASURE.SHOPIFY_DISCOUNT_RATE,
288
- category: MEASURE_CATEGORY.SALES,
289
- valueType: MeasureValueType.PERCENTAGE,
290
- decimalPlaces: 2,
291
- useCompactNotation: false,
292
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
293
- },
294
- [MEASURE.SHOPIFY_SUBTOTAL_AMOUNT]: {
295
- title: 'Subtotal Amount',
296
- description: 'The total amount of subtotals.',
297
- sumPrefix: '$',
298
- sumSuffix: '',
299
- avgPrefix: '$',
300
- avgSuffix: '',
301
- icon: 'shopify',
302
- measure: MEASURE.SHOPIFY_SUBTOTAL_AMOUNT,
303
- category: MEASURE_CATEGORY.SALES,
304
- valueType: MeasureValueType.CURRENCY,
305
- decimalPlaces: 2,
306
- useCompactNotation: true,
307
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
308
- },
309
- [MEASURE.SHOPIFY_NET_PLUS_SHIPPING_AMOUNT]: {
310
- title: 'Net Plus Shipping Amount',
311
- description: 'The total amount of net sales plus shipping.',
312
- sumPrefix: '$',
313
- sumSuffix: '',
314
- avgPrefix: '$',
315
- avgSuffix: '',
316
- icon: 'shopify',
317
- measure: MEASURE.SHOPIFY_NET_PLUS_SHIPPING_AMOUNT,
318
- category: MEASURE_CATEGORY.SALES,
319
- valueType: MeasureValueType.CURRENCY,
320
- decimalPlaces: 2,
321
- useCompactNotation: true,
322
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
323
- },
324
- [MEASURE.SHOPIFY_TOTAL_AOV]: {
325
- title: 'Total Average Order Value',
326
- description: 'The average value of an order.',
327
- sumPrefix: '$',
328
- sumSuffix: '',
329
- avgPrefix: '$',
330
- avgSuffix: '',
331
- icon: 'shopify',
332
- measure: MEASURE.SHOPIFY_TOTAL_AOV,
333
- category: MEASURE_CATEGORY.SALES,
334
- valueType: MeasureValueType.CURRENCY,
335
- decimalPlaces: 2,
336
- useCompactNotation: true,
337
- applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
338
- },
339
- [MEASURE.SHOPIFY_GROSS_AOV]: {
340
- title: 'Gross Average Order Value',
341
- description: 'The gross average value of an order (before refunds and discounts).',
342
- sumPrefix: '$',
343
- sumSuffix: '',
344
- avgPrefix: '$',
345
- avgSuffix: '',
346
- icon: 'shopify',
347
- measure: MEASURE.SHOPIFY_GROSS_AOV,
348
- category: MEASURE_CATEGORY.SALES,
349
- valueType: MeasureValueType.CURRENCY,
350
- decimalPlaces: 2,
351
- useCompactNotation: true,
352
- applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
353
- aliases: [MEASURE.SHOPIFY_AOV]
354
- },
355
- [MEASURE.SHOPIFY_NET_AOV]: {
356
- title: 'Net Average Order Value',
357
- description: 'The average value of an order after refunds.',
358
- sumPrefix: '$',
359
- sumSuffix: '',
360
- avgPrefix: '$',
361
- avgSuffix: '',
362
- icon: 'shopify',
363
- measure: MEASURE.SHOPIFY_NET_AOV,
364
- category: MEASURE_CATEGORY.SALES,
365
- valueType: MeasureValueType.CURRENCY,
366
- decimalPlaces: 2,
367
- useCompactNotation: true,
368
- applicableContexts: STANDARD_APPLICABLE_CONTEXTS
369
- },
370
- [MEASURE.SHOPIFY_TOP_PRODUCTS]: {
371
- title: 'Top Products',
372
- description: 'The top products by revenue.',
373
- sumPrefix: '',
374
- sumSuffix: '',
375
- avgPrefix: '',
376
- avgSuffix: '',
377
- icon: 'shopify',
378
- measure: MEASURE.SHOPIFY_TOP_PRODUCTS,
379
- category: MEASURE_CATEGORY.SALES,
380
- valueType: MeasureValueType.NUMBER,
381
- decimalPlaces: 0,
382
- useCompactNotation: false
383
- },
384
- [MEASURE.SHOPIFY_CUSTOMER_LTV]: {
385
- title: 'Customer Lifetime Value',
386
- description: 'The average value of a customer over their lifetime.',
387
- sumPrefix: '$',
388
- sumSuffix: '',
389
- avgPrefix: '$',
390
- avgSuffix: '',
391
- icon: 'shopify',
392
- measure: MEASURE.SHOPIFY_CUSTOMER_LTV,
393
- category: MEASURE_CATEGORY.LTV,
394
- valueType: MeasureValueType.CURRENCY,
395
- decimalPlaces: 2,
396
- useCompactNotation: true,
397
- },
398
- [MEASURE.SHOPIFY_TAX_AMOUNT]: {
399
- title: 'Tax Amount',
400
- description: 'The total amount of taxes.',
401
- sumPrefix: '$',
402
- sumSuffix: '',
403
- avgPrefix: '$',
404
- avgSuffix: '',
405
- icon: 'shopify',
406
- measure: MEASURE.SHOPIFY_TAX_AMOUNT,
407
- category: MEASURE_CATEGORY.SALES,
408
- valueType: MeasureValueType.CURRENCY,
409
- decimalPlaces: 2,
410
- useCompactNotation: true,
411
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
412
- },
413
- [MEASURE.SHOPIFY_SHIPPING_AMOUNT]: {
414
- title: 'Shipping Amount',
415
- description: 'The total amount of shipping.',
416
- sumPrefix: '$',
417
- sumSuffix: '',
418
- avgPrefix: '$',
419
- avgSuffix: '',
420
- icon: 'shopify',
421
- measure: MEASURE.SHOPIFY_SHIPPING_AMOUNT,
422
- category: MEASURE_CATEGORY.SALES,
423
- valueType: MeasureValueType.CURRENCY,
424
- decimalPlaces: 2,
425
- useCompactNotation: true,
426
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
427
- },
428
- [MEASURE.SHOPIFY_LTV]: {
429
- title: 'Lifetime Value',
430
- description: 'The average value of a customer over their lifetime.',
431
- sumPrefix: '$',
432
- sumSuffix: '',
433
- avgPrefix: '$',
434
- avgSuffix: '',
435
- icon: 'shopify',
436
- measure: MEASURE.SHOPIFY_LTV,
437
- category: MEASURE_CATEGORY.LTV,
438
- valueType: MeasureValueType.CURRENCY,
439
- decimalPlaces: 2,
440
- useCompactNotation: true,
441
- },
442
- [MEASURE.SHOPIFY_LTV_90]: {
443
- title: 'Lifetime Value (90 days)',
444
- description: 'The average value of a customer over the last 90 days.',
445
- sumPrefix: '$',
446
- sumSuffix: '',
447
- avgPrefix: '$',
448
- avgSuffix: '',
449
- icon: 'shopify',
450
- measure: MEASURE.SHOPIFY_LTV_90,
451
- category: MEASURE_CATEGORY.LTV,
452
- valueType: MeasureValueType.CURRENCY,
453
- decimalPlaces: 2,
454
- useCompactNotation: true,
455
- },
456
- [MEASURE.SHOPIFY_LTV_180]: {
457
- title: 'Lifetime Value (180 days)',
458
- description: 'The average value of a customer over the last 180 days.',
459
- sumPrefix: '$',
460
- sumSuffix: '',
461
- avgPrefix: '$',
462
- avgSuffix: '',
463
- icon: 'shopify',
464
- measure: MEASURE.SHOPIFY_LTV_180,
465
- category: MEASURE_CATEGORY.LTV,
466
- valueType: MeasureValueType.CURRENCY,
467
- decimalPlaces: 2,
468
- useCompactNotation: true,
469
- },
470
- [MEASURE.SHOPIFY_LTV_365]: {
471
- title: 'Lifetime Value (365 days)',
472
- description: 'The average value of a customer over the last 365 days.',
473
- sumPrefix: '$',
474
- sumSuffix: '',
475
- avgPrefix: '$',
476
- avgSuffix: '',
477
- icon: 'shopify',
478
- measure: MEASURE.SHOPIFY_LTV_365,
479
- category: MEASURE_CATEGORY.LTV,
480
- valueType: MeasureValueType.CURRENCY,
481
- decimalPlaces: 2,
482
- useCompactNotation: true,
483
- },
484
- [MEASURE.SHOPIFY_LTV_COHORT_GROSS_SALE_PRICE]: {
485
- title: 'Lifetime Value Cohort Gross Sale Price',
486
- description: 'The total amount of gross sales from a cohort.',
487
- sumPrefix: '$',
488
- sumSuffix: '',
489
- avgPrefix: '$',
490
- avgSuffix: '',
491
- icon: 'shopify',
492
- measure: MEASURE.SHOPIFY_LTV_COHORT_GROSS_SALE_PRICE,
493
- category: MEASURE_CATEGORY.LTV,
494
- valueType: MeasureValueType.CURRENCY,
495
- decimalPlaces: 2,
496
- useCompactNotation: true,
497
- applicableContexts: LTV_COHORT_APPLICABLE_CONTEXTS,
498
- },
499
- [MEASURE.SHOPIFY_LTV_COHORT_NET_SALE_PRICE]: {
500
- title: 'Lifetime Value Cohort Net Sale Price',
501
- description: 'The total amount of net sales from a cohort.',
502
- sumPrefix: '$',
503
- sumSuffix: '',
504
- avgPrefix: '$',
505
- avgSuffix: '',
506
- icon: 'shopify',
507
- measure: MEASURE.SHOPIFY_LTV_COHORT_NET_SALE_PRICE,
508
- category: MEASURE_CATEGORY.LTV,
509
- valueType: MeasureValueType.CURRENCY,
510
- decimalPlaces: 2,
511
- useCompactNotation: true,
512
- applicableContexts: LTV_COHORT_APPLICABLE_CONTEXTS,
513
- },
514
- [MEASURE.SHOPIFY_LTV_COHORT_NETT_SALE_PRICE]: {
515
- title: 'Lifetime Value Cohort Net Sale (plus taxes) Price',
516
- description: 'The total amount of net sales from a cohort (plus taxes).',
517
- sumPrefix: '$',
518
- sumSuffix: '',
519
- avgPrefix: '$',
520
- avgSuffix: '',
521
- icon: 'shopify',
522
- measure: MEASURE.SHOPIFY_LTV_COHORT_NETT_SALE_PRICE,
523
- category: MEASURE_CATEGORY.LTV,
524
- valueType: MeasureValueType.CURRENCY,
525
- decimalPlaces: 2,
526
- useCompactNotation: true,
527
- applicableContexts: LTV_COHORT_APPLICABLE_CONTEXTS,
528
- },
529
- [MEASURE.SHOPIFY_LTV_COHORT_NETTS_SALE_PRICE]: {
530
- title: 'Lifetime Value Cohort Net Sale (plus taxes, shipping) Price',
531
- description: 'The total amount of net sales from a cohort (plus taxes, shipping).',
532
- sumPrefix: '$',
533
- sumSuffix: '',
534
- avgPrefix: '$',
535
- avgSuffix: '',
536
- icon: 'shopify',
537
- measure: MEASURE.SHOPIFY_LTV_COHORT_NETTS_SALE_PRICE,
538
- category: MEASURE_CATEGORY.LTV,
539
- valueType: MeasureValueType.CURRENCY,
540
- decimalPlaces: 2,
541
- useCompactNotation: true,
542
- applicableContexts: LTV_COHORT_APPLICABLE_CONTEXTS,
543
- },
544
- [MEASURE.SHOPIFY_LTV_COHORT_NETS_SALE_PRICE]: {
545
- title: 'Lifetime Value Cohort Net Sale (plus shipping) Price',
546
- description: 'The total amount of net sales from a cohort (plus shipping).',
547
- sumPrefix: '$',
548
- sumSuffix: '',
549
- avgPrefix: '$',
550
- avgSuffix: '',
551
- icon: 'shopify',
552
- measure: MEASURE.SHOPIFY_LTV_COHORT_NETS_SALE_PRICE,
553
- category: MEASURE_CATEGORY.LTV,
554
- valueType: MeasureValueType.CURRENCY,
555
- decimalPlaces: 2,
556
- useCompactNotation: true,
557
- applicableContexts: LTV_COHORT_APPLICABLE_CONTEXTS,
558
- },
559
- [MEASURE.SHOPIFY_CUSTOMERS_COHORT]: {
560
- title: 'Customers Cohort',
561
- description: 'The number of customers in a cohort.',
562
- sumPrefix: '',
563
- sumSuffix: '',
564
- avgPrefix: '',
565
- avgSuffix: '',
566
- icon: 'shopify',
567
- measure: MEASURE.SHOPIFY_CUSTOMERS_COHORT,
568
- category: MEASURE_CATEGORY.LTV,
569
- valueType: MeasureValueType.NUMBER,
570
- decimalPlaces: 0,
571
- useCompactNotation: false,
572
- applicableContexts: LTV_COHORT_APPLICABLE_CONTEXTS,
573
- },
574
- [MEASURE.SHOPIFY_CUSTOMERS_RETENTION_RATE_COHORT]: {
575
- title: 'Customers Retention Rate Cohort',
576
- description: 'The percentage of customers retained in a cohort.',
577
- sumPrefix: '',
578
- sumSuffix: '%',
579
- avgPrefix: '',
580
- avgSuffix: '%',
581
- icon: 'shopify',
582
- measure: MEASURE.SHOPIFY_CUSTOMERS_RETENTION_RATE_COHORT,
583
- category: MEASURE_CATEGORY.LTV,
584
- valueType: MeasureValueType.PERCENTAGE,
585
- decimalPlaces: 2,
586
- useCompactNotation: false,
587
- applicableContexts: LTV_COHORT_APPLICABLE_CONTEXTS,
588
- },
589
- [MEASURE.SHOPIFY_AVG_ORDER_VALUE_COHORT]: {
590
- title: 'Average Order Value Cohort',
591
- description: 'The average value of an order in a cohort.',
592
- sumPrefix: '$',
593
- sumSuffix: '',
594
- avgPrefix: '$',
595
- avgSuffix: '',
596
- icon: 'shopify',
597
- measure: MEASURE.SHOPIFY_AVG_ORDER_VALUE_COHORT,
598
- category: MEASURE_CATEGORY.LTV,
599
- valueType: MeasureValueType.CURRENCY,
600
- decimalPlaces: 2,
601
- useCompactNotation: true,
602
- applicableContexts: LTV_COHORT_APPLICABLE_CONTEXTS,
603
- },
604
- [MEASURE.SHOPIFY_REFUND_PLUS_DISCOUNT_AMOUNT]: {
605
- title: 'Refund Plus Discount Amount',
606
- description: 'The amount of refunds plus discounts given to all customers.',
607
- sumPrefix: '$',
608
- sumSuffix: '',
609
- avgPrefix: '$',
610
- avgSuffix: '',
611
- icon: 'shopify',
612
- measure: MEASURE.SHOPIFY_REFUND_PLUS_DISCOUNT_AMOUNT,
613
- category: MEASURE_CATEGORY.SALES,
614
- valueType: MeasureValueType.CURRENCY,
615
- decimalPlaces: 2,
616
- useCompactNotation: true,
617
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
618
- },
619
- [MEASURE.SHOPIFY_AVG_ORDERS_PER_CUSTOMER]: {
620
- title: 'Average Orders per Customer',
621
- description: 'The average number of orders per customer.',
622
- sumPrefix: '',
623
- sumSuffix: '',
624
- avgPrefix: '',
625
- avgSuffix: '',
626
- icon: 'shopify',
627
- measure: MEASURE.SHOPIFY_AVG_ORDERS_PER_CUSTOMER,
628
- category: MEASURE_CATEGORY.SALES,
629
- valueType: MeasureValueType.NUMBER,
630
- decimalPlaces: 0,
631
- useCompactNotation: false,
632
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
633
- },
634
- [MEASURE.SHOPIFY_ORDER_TOTAL_PRODUCT_COST]: {
635
- title: 'Order Total Product Cost',
636
- description: 'The total cost of the products in an order.',
637
- sumPrefix: '$',
638
- sumSuffix: '',
639
- avgPrefix: '$',
640
- avgSuffix: '',
641
- icon: 'shopify',
642
- measure: MEASURE.SHOPIFY_ORDER_TOTAL_PRODUCT_COST,
643
- category: MEASURE_CATEGORY.SALES,
644
- valueType: MeasureValueType.CURRENCY,
645
- decimalPlaces: 2,
646
- useCompactNotation: true,
647
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
648
- },
649
- [MEASURE.SHOPIFY_ORDER_TOTAL_PRODUCT_COST_GROSS_PERCENT]: {
650
- title: 'Order Total Product Cost (% of Gross Sales)',
651
- description: 'The percentage of gross sales that represents the total product cost.',
652
- sumPrefix: '',
653
- sumSuffix: '%',
654
- avgPrefix: '',
655
- avgSuffix: '%',
656
- icon: 'shopify',
657
- measure: MEASURE.SHOPIFY_ORDER_TOTAL_PRODUCT_COST_GROSS_PERCENT,
658
- category: MEASURE_CATEGORY.SALES,
659
- valueType: MeasureValueType.PERCENTAGE,
660
- decimalPlaces: 2,
661
- useCompactNotation: false,
662
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
663
- },
664
- [MEASURE.SHOPIFY_ORDER_TOTAL_PRODUCT_COST_NET_PERCENT]: {
665
- title: 'Order Total Product Cost (% of Net Sales)',
666
- description: 'The percentage of net sales that represents the total product cost.',
667
- sumPrefix: '',
668
- sumSuffix: '%',
669
- avgPrefix: '',
670
- avgSuffix: '%',
671
- icon: 'shopify',
672
- measure: MEASURE.SHOPIFY_ORDER_TOTAL_PRODUCT_COST_NET_PERCENT,
673
- category: MEASURE_CATEGORY.SALES,
674
- valueType: MeasureValueType.PERCENTAGE,
675
- decimalPlaces: 2,
676
- useCompactNotation: false,
677
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
678
- },
679
- [MEASURE.SHOPIFY_GROSS_PRODUCT_MARGIN]: {
680
- title: 'Gross Product Margin',
681
- description: 'Shopify gross margin (Gross Sales - Total Product Cost)',
682
- sumPrefix: '$',
683
- sumSuffix: '',
684
- avgPrefix: '$',
685
- avgSuffix: '',
686
- icon: 'shopify',
687
- measure: MEASURE.SHOPIFY_GROSS_PRODUCT_MARGIN,
688
- category: MEASURE_CATEGORY.SALES,
689
- valueType: MeasureValueType.CURRENCY,
690
- decimalPlaces: 2,
691
- useCompactNotation: true,
692
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
693
- },
694
- [MEASURE.SHOPIFY_GROSS_PRODUCT_MARGIN_GROSS_PERCENT]: {
695
- title: 'Gross Product Margin (% of Gross Sales)',
696
- description: 'The percentage of gross sales that represents the gross product margin.',
697
- sumPrefix: '',
698
- sumSuffix: '%',
699
- avgPrefix: '',
700
- avgSuffix: '%',
701
- icon: 'shopify',
702
- measure: MEASURE.SHOPIFY_GROSS_PRODUCT_MARGIN_GROSS_PERCENT,
703
- category: MEASURE_CATEGORY.SALES,
704
- valueType: MeasureValueType.PERCENTAGE,
705
- decimalPlaces: 2,
706
- useCompactNotation: false,
707
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
708
- },
709
- [MEASURE.SHOPIFY_GROSS_PRODUCT_MARGIN_NET_PERCENT]: {
710
- title: 'Gross Product Margin (% of Net Sales)',
711
- description: 'The percentage of net sales that represents the gross product margin.',
712
- sumPrefix: '',
713
- sumSuffix: '%',
714
- avgPrefix: '',
715
- avgSuffix: '%',
716
- icon: 'shopify',
717
- measure: MEASURE.SHOPIFY_GROSS_PRODUCT_MARGIN_NET_PERCENT,
718
- category: MEASURE_CATEGORY.SALES,
719
- valueType: MeasureValueType.PERCENTAGE,
720
- decimalPlaces: 2,
721
- useCompactNotation: false,
722
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
723
- },
724
- [MEASURE.SHOPIFY_NET_PRODUCT_MARGIN]: {
725
- title: 'Net Product Margin',
726
- description: 'Shopify net margin (Net Sales - Total Product Cost)',
727
- sumPrefix: '$',
728
- sumSuffix: '',
729
- avgPrefix: '$',
730
- avgSuffix: '',
731
- icon: 'shopify',
732
- measure: MEASURE.SHOPIFY_NET_PRODUCT_MARGIN,
733
- category: MEASURE_CATEGORY.SALES,
734
- valueType: MeasureValueType.CURRENCY,
735
- decimalPlaces: 2,
736
- useCompactNotation: true,
737
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
738
- },
739
- [MEASURE.SHOPIFY_NET_PRODUCT_MARGIN_GROSS_PERCENT]: {
740
- title: 'Net Product Margin (% of Gross Sales)',
741
- description: 'The percentage of gross sales that represents the net product margin.',
742
- sumPrefix: '',
743
- sumSuffix: '%',
744
- avgPrefix: '',
745
- avgSuffix: '%',
746
- icon: 'shopify',
747
- measure: MEASURE.SHOPIFY_NET_PRODUCT_MARGIN_GROSS_PERCENT,
748
- category: MEASURE_CATEGORY.SALES,
749
- valueType: MeasureValueType.PERCENTAGE,
750
- decimalPlaces: 2,
751
- useCompactNotation: false,
752
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
753
- },
754
- [MEASURE.SHOPIFY_NET_PRODUCT_MARGIN_NET_PERCENT]: {
755
- title: 'Net Product Margin (% of Net Sales)',
756
- description: 'The percentage of net sales that represents the net product margin.',
757
- sumPrefix: '',
758
- sumSuffix: '%',
759
- avgPrefix: '',
760
- avgSuffix: '%',
761
- icon: 'shopify',
762
- measure: MEASURE.SHOPIFY_NET_PRODUCT_MARGIN_NET_PERCENT,
763
- category: MEASURE_CATEGORY.SALES,
764
- valueType: MeasureValueType.PERCENTAGE,
765
- decimalPlaces: 2,
766
- useCompactNotation: false,
767
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
768
- },
769
- [MEASURE.SHOPIFY_GROSS_MARGIN]: {
770
- title: 'Gross Margin',
771
- description: 'Shopify gross margin (Gross Sales - Total Product Cost - Ad Spend)',
772
- sumPrefix: '$',
773
- sumSuffix: '',
774
- avgPrefix: '$',
775
- avgSuffix: '',
776
- icon: 'shopify',
777
- measure: MEASURE.SHOPIFY_GROSS_MARGIN,
778
- category: MEASURE_CATEGORY.SALES,
779
- valueType: MeasureValueType.CURRENCY,
780
- decimalPlaces: 2,
781
- useCompactNotation: true,
782
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
783
- },
784
- [MEASURE.SHOPIFY_GROSS_MARGIN_GROSS_PERCENT]: {
785
- title: 'Gross Margin (% of Gross Sales)',
786
- description: 'The percentage of gross sales that represents the gross margin.',
787
- sumPrefix: '',
788
- sumSuffix: '%',
789
- avgPrefix: '',
790
- avgSuffix: '%',
791
- icon: 'shopify',
792
- measure: MEASURE.SHOPIFY_GROSS_MARGIN_GROSS_PERCENT,
793
- category: MEASURE_CATEGORY.SALES,
794
- valueType: MeasureValueType.PERCENTAGE,
795
- decimalPlaces: 2,
796
- useCompactNotation: false,
797
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
798
- },
799
- [MEASURE.SHOPIFY_GROSS_MARGIN_NET_PERCENT]: {
800
- title: 'Gross Margin (% of Net Sales)',
801
- description: 'The percentage of net sales that represents the gross margin.',
802
- sumPrefix: '',
803
- sumSuffix: '%',
804
- avgPrefix: '',
805
- avgSuffix: '%',
806
- icon: 'shopify',
807
- measure: MEASURE.SHOPIFY_GROSS_MARGIN_NET_PERCENT,
808
- category: MEASURE_CATEGORY.SALES,
809
- valueType: MeasureValueType.PERCENTAGE,
810
- decimalPlaces: 2,
811
- useCompactNotation: false,
812
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
813
- },
814
- [MEASURE.SHOPIFY_NET_MARGIN]: {
815
- title: 'Net Margin',
816
- description: 'Shopify net margin (Net Sales - Total Product Cost - Ad Spend)',
817
- sumPrefix: '$',
818
- sumSuffix: '',
819
- avgPrefix: '$',
820
- avgSuffix: '',
821
- icon: 'shopify',
822
- measure: MEASURE.SHOPIFY_NET_MARGIN,
823
- category: MEASURE_CATEGORY.SALES,
824
- valueType: MeasureValueType.CURRENCY,
825
- decimalPlaces: 2,
826
- useCompactNotation: true,
827
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
828
- },
829
- [MEASURE.SHOPIFY_NET_MARGIN_GROSS_PERCENT]: {
830
- title: 'Net Margin (% of Gross Sales)',
831
- description: 'The percentage of gross sales that represents the net margin.',
832
- sumPrefix: '',
833
- sumSuffix: '%',
834
- avgPrefix: '',
835
- avgSuffix: '%',
836
- icon: 'shopify',
837
- measure: MEASURE.SHOPIFY_NET_MARGIN_GROSS_PERCENT,
838
- category: MEASURE_CATEGORY.SALES,
839
- valueType: MeasureValueType.PERCENTAGE,
840
- decimalPlaces: 2,
841
- useCompactNotation: false,
842
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
843
- },
844
- [MEASURE.SHOPIFY_NET_MARGIN_NET_PERCENT]: {
845
- title: 'Net Margin (% of Net Sales)',
846
- description: 'The percentage of net sales that represents the net margin.',
847
- sumPrefix: '',
848
- sumSuffix: '%',
849
- avgPrefix: '',
850
- avgSuffix: '%',
851
- icon: 'shopify',
852
- measure: MEASURE.SHOPIFY_NET_MARGIN_NET_PERCENT,
853
- category: MEASURE_CATEGORY.SALES,
854
- valueType: MeasureValueType.PERCENTAGE,
855
- decimalPlaces: 2,
856
- useCompactNotation: false,
857
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
858
- },
859
- ...SHOPIFY_NEW_CUSTOMER_MEASURES_MAP,
860
- ...SHOPIFY_RETURNING_CUSTOMER_MEASURES_MAP,
861
- };
1
+ import { MEASURE } from '../../measures.js';
2
+ import { MEASURE_CATEGORY } from '../measure-categories.js';
3
+ import { MeasureValueType } from '../measure-value-type.js';
4
+ import { SHOPIFY_NEW_CUSTOMER_MEASURES_MAP } from './shopify-nc-measure-definitions.js';
5
+ import { SHOPIFY_RETURNING_CUSTOMER_MEASURES_MAP } from './shopify-rc-measure-definitions.js';
6
+ import { CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS, STANDARD_APPLICABLE_CONTEXTS, LTV_COHORT_APPLICABLE_CONTEXTS } from '../measure-applicable-contexts.js';
7
+ export const SHOPIFY_MEASURES_MAP = {
8
+ [MEASURE.SHOPIFY_ORDERS]: {
9
+ title: 'Orders',
10
+ description: 'The number of orders.',
11
+ sumPrefix: '',
12
+ sumSuffix: '',
13
+ avgPrefix: '',
14
+ avgSuffix: '',
15
+ icon: 'shopify',
16
+ measure: MEASURE.SHOPIFY_ORDERS,
17
+ category: MEASURE_CATEGORY.SALES,
18
+ valueType: MeasureValueType.NUMBER,
19
+ decimalPlaces: 0,
20
+ useCompactNotation: false,
21
+ applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
22
+ },
23
+ [MEASURE.SHOPIFY_CUSTOMERS]: {
24
+ title: 'Customers',
25
+ description: 'The number of customers.',
26
+ sumPrefix: '',
27
+ sumSuffix: '',
28
+ avgPrefix: '',
29
+ avgSuffix: '',
30
+ icon: 'shopify',
31
+ measure: MEASURE.SHOPIFY_CUSTOMERS,
32
+ category: MEASURE_CATEGORY.SALES,
33
+ valueType: MeasureValueType.NUMBER,
34
+ decimalPlaces: 0,
35
+ useCompactNotation: false,
36
+ applicableContexts: STANDARD_APPLICABLE_CONTEXTS
37
+ },
38
+ [MEASURE.SHOPIFY_TOTAL_REVENUE]: {
39
+ title: 'Total Revenue',
40
+ description: 'The total revenue generated.',
41
+ sumPrefix: '$',
42
+ sumSuffix: '',
43
+ avgPrefix: '$',
44
+ avgSuffix: '',
45
+ icon: 'shopify',
46
+ measure: MEASURE.SHOPIFY_TOTAL_REVENUE,
47
+ category: MEASURE_CATEGORY.SALES,
48
+ valueType: MeasureValueType.CURRENCY,
49
+ decimalPlaces: 2,
50
+ useCompactNotation: true,
51
+ applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
52
+ aliases: [MEASURE.SHOPIFY_TOTAL_AMOUNT, MEASURE.SHOPIFY_REVENUE, MEASURE.SHOPIFY_TOTAL_SALES],
53
+ },
54
+ [MEASURE.SHOPIFY_GROSS_SALES]: {
55
+ title: 'Gross Sales',
56
+ description: 'Product price * quantity (before taxes, shipping, discounts and returns)',
57
+ sumPrefix: '$',
58
+ sumSuffix: '',
59
+ avgPrefix: '$',
60
+ avgSuffix: '',
61
+ icon: 'shopify',
62
+ measure: MEASURE.SHOPIFY_GROSS_SALES,
63
+ category: MEASURE_CATEGORY.SALES,
64
+ valueType: MeasureValueType.CURRENCY,
65
+ decimalPlaces: 2,
66
+ useCompactNotation: true,
67
+ applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
68
+ },
69
+ [MEASURE.SHOPIFY_NET_SALES]: {
70
+ title: 'Net Sales',
71
+ description: 'Gross Sales - Discounts - Returns',
72
+ sumPrefix: '$',
73
+ sumSuffix: '',
74
+ avgPrefix: '$',
75
+ avgSuffix: '',
76
+ icon: 'shopify',
77
+ measure: MEASURE.SHOPIFY_NET_SALES,
78
+ category: MEASURE_CATEGORY.SALES,
79
+ valueType: MeasureValueType.CURRENCY,
80
+ decimalPlaces: 2,
81
+ useCompactNotation: true,
82
+ applicableContexts: STANDARD_APPLICABLE_CONTEXTS
83
+ },
84
+ [MEASURE.SHOPIFY_ABANDONED_CHECKOUTS_VALUE]: {
85
+ title: 'Abandoned Checkouts Value',
86
+ description: 'The total value of abandoned checkouts.',
87
+ sumPrefix: '$',
88
+ sumSuffix: '',
89
+ avgPrefix: '$',
90
+ avgSuffix: '',
91
+ icon: 'shopify',
92
+ measure: MEASURE.SHOPIFY_ABANDONED_CHECKOUTS_VALUE,
93
+ category: MEASURE_CATEGORY.SALES,
94
+ valueType: MeasureValueType.CURRENCY,
95
+ decimalPlaces: 2,
96
+ useCompactNotation: true,
97
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
98
+ },
99
+ [MEASURE.SHOPIFY_ABANDONED_CHECKOUTS]: {
100
+ title: 'Abandoned Checkouts',
101
+ description: 'The number of abandoned checkouts.',
102
+ sumPrefix: '',
103
+ sumSuffix: '',
104
+ avgPrefix: '',
105
+ avgSuffix: '',
106
+ icon: 'shopify',
107
+ measure: MEASURE.SHOPIFY_ABANDONED_CHECKOUTS,
108
+ category: MEASURE_CATEGORY.SALES,
109
+ valueType: MeasureValueType.NUMBER,
110
+ decimalPlaces: 0,
111
+ useCompactNotation: false,
112
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
113
+ },
114
+ [MEASURE.SHOPIFY_CANCELLED_ORDERS]: {
115
+ title: 'Cancelled Orders',
116
+ description: 'The number of cancelled orders.',
117
+ sumPrefix: '',
118
+ sumSuffix: '',
119
+ avgPrefix: '',
120
+ avgSuffix: '',
121
+ icon: 'shopify',
122
+ measure: MEASURE.SHOPIFY_CANCELLED_ORDERS,
123
+ category: MEASURE_CATEGORY.SALES,
124
+ valueType: MeasureValueType.NUMBER,
125
+ decimalPlaces: 0,
126
+ useCompactNotation: false,
127
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
128
+ },
129
+ [MEASURE.SHOPIFY_CANCELLED_AMOUNT]: {
130
+ title: 'Cancelled Amount',
131
+ description: 'The total amount of cancelled orders.',
132
+ sumPrefix: '$',
133
+ sumSuffix: '',
134
+ avgPrefix: '$',
135
+ avgSuffix: '',
136
+ icon: 'shopify',
137
+ measure: MEASURE.SHOPIFY_CANCELLED_AMOUNT,
138
+ category: MEASURE_CATEGORY.SALES,
139
+ valueType: MeasureValueType.CURRENCY,
140
+ decimalPlaces: 2,
141
+ useCompactNotation: true,
142
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
143
+ },
144
+ [MEASURE.SHOPIFY_REFUNDS]: {
145
+ title: 'Refunded Orders',
146
+ description: 'The number of orders that were refunded.',
147
+ sumPrefix: '',
148
+ sumSuffix: '',
149
+ avgPrefix: '',
150
+ avgSuffix: '',
151
+ icon: 'shopify',
152
+ measure: MEASURE.SHOPIFY_REFUNDS,
153
+ category: MEASURE_CATEGORY.SALES,
154
+ valueType: MeasureValueType.NUMBER,
155
+ decimalPlaces: 0,
156
+ useCompactNotation: false,
157
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
158
+ },
159
+ [MEASURE.SHOPIFY_REFUND_AMOUNT_REFUND_DATE]: {
160
+ title: 'Refund Amount By Date of Refund',
161
+ description: 'The total amount of refunds by refund date.',
162
+ sumPrefix: '$',
163
+ sumSuffix: '',
164
+ avgPrefix: '$',
165
+ avgSuffix: '',
166
+ icon: 'shopify',
167
+ measure: MEASURE.SHOPIFY_REFUND_AMOUNT_REFUND_DATE,
168
+ category: MEASURE_CATEGORY.SALES,
169
+ valueType: MeasureValueType.CURRENCY,
170
+ decimalPlaces: 2,
171
+ useCompactNotation: true,
172
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
173
+ },
174
+ [MEASURE.SHOPIFY_REFUND_AMOUNT_ORDER_DATE]: {
175
+ title: 'Refund Amount By Date of Order',
176
+ description: 'The total amount of refunds by order date.',
177
+ sumPrefix: '$',
178
+ sumSuffix: '',
179
+ avgPrefix: '$',
180
+ avgSuffix: '',
181
+ icon: 'shopify',
182
+ measure: MEASURE.SHOPIFY_REFUND_AMOUNT_ORDER_DATE,
183
+ category: MEASURE_CATEGORY.SALES,
184
+ valueType: MeasureValueType.CURRENCY,
185
+ decimalPlaces: 2,
186
+ useCompactNotation: true,
187
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
188
+ },
189
+ [MEASURE.SHOPIFY_REFUND_GROSS_PERCENT]: {
190
+ title: 'Refund Rate (% of Gross Sales)',
191
+ description: 'The percentage of gross sales amount that was refunded.',
192
+ sumPrefix: '',
193
+ sumSuffix: '%',
194
+ avgPrefix: '',
195
+ avgSuffix: '%',
196
+ icon: 'shopify',
197
+ measure: MEASURE.SHOPIFY_REFUND_GROSS_PERCENT,
198
+ category: MEASURE_CATEGORY.SALES,
199
+ valueType: MeasureValueType.PERCENTAGE,
200
+ decimalPlaces: 2,
201
+ useCompactNotation: false,
202
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
203
+ },
204
+ [MEASURE.SHOPIFY_REFUND_NET_PERCENT]: {
205
+ title: 'Refund Rate (% of Net Sales)',
206
+ description: 'The percentage of net sales amount that was refunded.',
207
+ sumPrefix: '',
208
+ sumSuffix: '%',
209
+ avgPrefix: '',
210
+ avgSuffix: '%',
211
+ icon: 'shopify',
212
+ measure: MEASURE.SHOPIFY_REFUND_NET_PERCENT,
213
+ category: MEASURE_CATEGORY.SALES,
214
+ valueType: MeasureValueType.PERCENTAGE,
215
+ decimalPlaces: 2,
216
+ useCompactNotation: false,
217
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
218
+ },
219
+ [MEASURE.SHOPIFY_REFUND_RATE]: {
220
+ title: 'Refunded Order Rate',
221
+ description: 'The percentage of total orders that were refunded.',
222
+ sumPrefix: '',
223
+ sumSuffix: '%',
224
+ avgPrefix: '',
225
+ avgSuffix: '%',
226
+ icon: 'shopify',
227
+ measure: MEASURE.SHOPIFY_REFUND_RATE,
228
+ category: MEASURE_CATEGORY.SALES,
229
+ valueType: MeasureValueType.PERCENTAGE,
230
+ decimalPlaces: 2,
231
+ useCompactNotation: false,
232
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
233
+ },
234
+ [MEASURE.SHOPIFY_DISCOUNTS]: {
235
+ title: 'Discounted Orders',
236
+ description: 'The number of orders that were discounted.',
237
+ sumPrefix: '',
238
+ sumSuffix: '',
239
+ avgPrefix: '',
240
+ avgSuffix: '',
241
+ icon: 'shopify',
242
+ measure: MEASURE.SHOPIFY_DISCOUNTS,
243
+ category: MEASURE_CATEGORY.SALES,
244
+ valueType: MeasureValueType.NUMBER,
245
+ decimalPlaces: 0,
246
+ useCompactNotation: false,
247
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
248
+ },
249
+ [MEASURE.SHOPIFY_DISCOUNT_AMOUNT]: {
250
+ title: 'Discount Amount',
251
+ description: 'The total amount of discounts applied to all orders.',
252
+ sumPrefix: '$',
253
+ sumSuffix: '',
254
+ avgPrefix: '$',
255
+ avgSuffix: '',
256
+ icon: 'shopify',
257
+ measure: MEASURE.SHOPIFY_DISCOUNT_AMOUNT,
258
+ category: MEASURE_CATEGORY.SALES,
259
+ valueType: MeasureValueType.CURRENCY,
260
+ decimalPlaces: 2,
261
+ useCompactNotation: true,
262
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
263
+ },
264
+ [MEASURE.SHOPIFY_DISCOUNT_GROSS_PERCENT]: {
265
+ title: 'Discount Rate (% of Gross Sales)',
266
+ description: 'The percentage of gross sales amount that was discounted.',
267
+ sumPrefix: '',
268
+ sumSuffix: '%',
269
+ avgPrefix: '',
270
+ avgSuffix: '%',
271
+ icon: 'shopify',
272
+ measure: MEASURE.SHOPIFY_DISCOUNT_GROSS_PERCENT,
273
+ category: MEASURE_CATEGORY.SALES,
274
+ valueType: MeasureValueType.PERCENTAGE,
275
+ decimalPlaces: 2,
276
+ useCompactNotation: false,
277
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
278
+ },
279
+ [MEASURE.SHOPIFY_DISCOUNT_RATE]: {
280
+ title: 'Discounted Order Rate',
281
+ description: 'The percentage of total orders that were discounted.',
282
+ sumPrefix: '',
283
+ sumSuffix: '%',
284
+ avgPrefix: '',
285
+ avgSuffix: '%',
286
+ icon: 'shopify',
287
+ measure: MEASURE.SHOPIFY_DISCOUNT_RATE,
288
+ category: MEASURE_CATEGORY.SALES,
289
+ valueType: MeasureValueType.PERCENTAGE,
290
+ decimalPlaces: 2,
291
+ useCompactNotation: false,
292
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
293
+ },
294
+ [MEASURE.SHOPIFY_SUBTOTAL_AMOUNT]: {
295
+ title: 'Subtotal Amount',
296
+ description: 'The total amount of subtotals.',
297
+ sumPrefix: '$',
298
+ sumSuffix: '',
299
+ avgPrefix: '$',
300
+ avgSuffix: '',
301
+ icon: 'shopify',
302
+ measure: MEASURE.SHOPIFY_SUBTOTAL_AMOUNT,
303
+ category: MEASURE_CATEGORY.SALES,
304
+ valueType: MeasureValueType.CURRENCY,
305
+ decimalPlaces: 2,
306
+ useCompactNotation: true,
307
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
308
+ },
309
+ [MEASURE.SHOPIFY_NET_PLUS_SHIPPING_AMOUNT]: {
310
+ title: 'Net Plus Shipping Amount',
311
+ description: 'The total amount of net sales plus shipping.',
312
+ sumPrefix: '$',
313
+ sumSuffix: '',
314
+ avgPrefix: '$',
315
+ avgSuffix: '',
316
+ icon: 'shopify',
317
+ measure: MEASURE.SHOPIFY_NET_PLUS_SHIPPING_AMOUNT,
318
+ category: MEASURE_CATEGORY.SALES,
319
+ valueType: MeasureValueType.CURRENCY,
320
+ decimalPlaces: 2,
321
+ useCompactNotation: true,
322
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
323
+ },
324
+ [MEASURE.SHOPIFY_TOTAL_AOV]: {
325
+ title: 'Total Average Order Value',
326
+ description: 'The average value of an order.',
327
+ sumPrefix: '$',
328
+ sumSuffix: '',
329
+ avgPrefix: '$',
330
+ avgSuffix: '',
331
+ icon: 'shopify',
332
+ measure: MEASURE.SHOPIFY_TOTAL_AOV,
333
+ category: MEASURE_CATEGORY.SALES,
334
+ valueType: MeasureValueType.CURRENCY,
335
+ decimalPlaces: 2,
336
+ useCompactNotation: true,
337
+ applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
338
+ },
339
+ [MEASURE.SHOPIFY_GROSS_AOV]: {
340
+ title: 'Gross Average Order Value',
341
+ description: 'The gross average value of an order (before refunds and discounts).',
342
+ sumPrefix: '$',
343
+ sumSuffix: '',
344
+ avgPrefix: '$',
345
+ avgSuffix: '',
346
+ icon: 'shopify',
347
+ measure: MEASURE.SHOPIFY_GROSS_AOV,
348
+ category: MEASURE_CATEGORY.SALES,
349
+ valueType: MeasureValueType.CURRENCY,
350
+ decimalPlaces: 2,
351
+ useCompactNotation: true,
352
+ applicableContexts: STANDARD_APPLICABLE_CONTEXTS,
353
+ aliases: [MEASURE.SHOPIFY_AOV]
354
+ },
355
+ [MEASURE.SHOPIFY_NET_AOV]: {
356
+ title: 'Net Average Order Value',
357
+ description: 'The average value of an order after refunds.',
358
+ sumPrefix: '$',
359
+ sumSuffix: '',
360
+ avgPrefix: '$',
361
+ avgSuffix: '',
362
+ icon: 'shopify',
363
+ measure: MEASURE.SHOPIFY_NET_AOV,
364
+ category: MEASURE_CATEGORY.SALES,
365
+ valueType: MeasureValueType.CURRENCY,
366
+ decimalPlaces: 2,
367
+ useCompactNotation: true,
368
+ applicableContexts: STANDARD_APPLICABLE_CONTEXTS
369
+ },
370
+ [MEASURE.SHOPIFY_TOP_PRODUCTS]: {
371
+ title: 'Top Products',
372
+ description: 'The top products by revenue.',
373
+ sumPrefix: '',
374
+ sumSuffix: '',
375
+ avgPrefix: '',
376
+ avgSuffix: '',
377
+ icon: 'shopify',
378
+ measure: MEASURE.SHOPIFY_TOP_PRODUCTS,
379
+ category: MEASURE_CATEGORY.SALES,
380
+ valueType: MeasureValueType.NUMBER,
381
+ decimalPlaces: 0,
382
+ useCompactNotation: false
383
+ },
384
+ [MEASURE.SHOPIFY_CUSTOMER_LTV]: {
385
+ title: 'Customer Lifetime Value',
386
+ description: 'The average value of a customer over their lifetime.',
387
+ sumPrefix: '$',
388
+ sumSuffix: '',
389
+ avgPrefix: '$',
390
+ avgSuffix: '',
391
+ icon: 'shopify',
392
+ measure: MEASURE.SHOPIFY_CUSTOMER_LTV,
393
+ category: MEASURE_CATEGORY.LTV,
394
+ valueType: MeasureValueType.CURRENCY,
395
+ decimalPlaces: 2,
396
+ useCompactNotation: true,
397
+ },
398
+ [MEASURE.SHOPIFY_TAX_AMOUNT]: {
399
+ title: 'Tax Amount',
400
+ description: 'The total amount of taxes.',
401
+ sumPrefix: '$',
402
+ sumSuffix: '',
403
+ avgPrefix: '$',
404
+ avgSuffix: '',
405
+ icon: 'shopify',
406
+ measure: MEASURE.SHOPIFY_TAX_AMOUNT,
407
+ category: MEASURE_CATEGORY.SALES,
408
+ valueType: MeasureValueType.CURRENCY,
409
+ decimalPlaces: 2,
410
+ useCompactNotation: true,
411
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
412
+ },
413
+ [MEASURE.SHOPIFY_SHIPPING_AMOUNT]: {
414
+ title: 'Shipping Amount',
415
+ description: 'The total amount of shipping.',
416
+ sumPrefix: '$',
417
+ sumSuffix: '',
418
+ avgPrefix: '$',
419
+ avgSuffix: '',
420
+ icon: 'shopify',
421
+ measure: MEASURE.SHOPIFY_SHIPPING_AMOUNT,
422
+ category: MEASURE_CATEGORY.SALES,
423
+ valueType: MeasureValueType.CURRENCY,
424
+ decimalPlaces: 2,
425
+ useCompactNotation: true,
426
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
427
+ },
428
+ [MEASURE.SHOPIFY_LTV]: {
429
+ title: 'Lifetime Value',
430
+ description: 'The average value of a customer over their lifetime.',
431
+ sumPrefix: '$',
432
+ sumSuffix: '',
433
+ avgPrefix: '$',
434
+ avgSuffix: '',
435
+ icon: 'shopify',
436
+ measure: MEASURE.SHOPIFY_LTV,
437
+ category: MEASURE_CATEGORY.LTV,
438
+ valueType: MeasureValueType.CURRENCY,
439
+ decimalPlaces: 2,
440
+ useCompactNotation: true,
441
+ },
442
+ [MEASURE.SHOPIFY_LTV_90]: {
443
+ title: 'Lifetime Value (90 days)',
444
+ description: 'The average value of a customer over the last 90 days.',
445
+ sumPrefix: '$',
446
+ sumSuffix: '',
447
+ avgPrefix: '$',
448
+ avgSuffix: '',
449
+ icon: 'shopify',
450
+ measure: MEASURE.SHOPIFY_LTV_90,
451
+ category: MEASURE_CATEGORY.LTV,
452
+ valueType: MeasureValueType.CURRENCY,
453
+ decimalPlaces: 2,
454
+ useCompactNotation: true,
455
+ },
456
+ [MEASURE.SHOPIFY_LTV_180]: {
457
+ title: 'Lifetime Value (180 days)',
458
+ description: 'The average value of a customer over the last 180 days.',
459
+ sumPrefix: '$',
460
+ sumSuffix: '',
461
+ avgPrefix: '$',
462
+ avgSuffix: '',
463
+ icon: 'shopify',
464
+ measure: MEASURE.SHOPIFY_LTV_180,
465
+ category: MEASURE_CATEGORY.LTV,
466
+ valueType: MeasureValueType.CURRENCY,
467
+ decimalPlaces: 2,
468
+ useCompactNotation: true,
469
+ },
470
+ [MEASURE.SHOPIFY_LTV_365]: {
471
+ title: 'Lifetime Value (365 days)',
472
+ description: 'The average value of a customer over the last 365 days.',
473
+ sumPrefix: '$',
474
+ sumSuffix: '',
475
+ avgPrefix: '$',
476
+ avgSuffix: '',
477
+ icon: 'shopify',
478
+ measure: MEASURE.SHOPIFY_LTV_365,
479
+ category: MEASURE_CATEGORY.LTV,
480
+ valueType: MeasureValueType.CURRENCY,
481
+ decimalPlaces: 2,
482
+ useCompactNotation: true,
483
+ },
484
+ [MEASURE.SHOPIFY_LTV_COHORT_GROSS_SALE_PRICE]: {
485
+ title: 'Lifetime Value Cohort Gross Sale Price',
486
+ description: 'The total amount of gross sales from a cohort.',
487
+ sumPrefix: '$',
488
+ sumSuffix: '',
489
+ avgPrefix: '$',
490
+ avgSuffix: '',
491
+ icon: 'shopify',
492
+ measure: MEASURE.SHOPIFY_LTV_COHORT_GROSS_SALE_PRICE,
493
+ category: MEASURE_CATEGORY.LTV,
494
+ valueType: MeasureValueType.CURRENCY,
495
+ decimalPlaces: 2,
496
+ useCompactNotation: true,
497
+ applicableContexts: LTV_COHORT_APPLICABLE_CONTEXTS,
498
+ },
499
+ [MEASURE.SHOPIFY_LTV_COHORT_NET_SALE_PRICE]: {
500
+ title: 'Lifetime Value Cohort Net Sale Price',
501
+ description: 'The total amount of net sales from a cohort.',
502
+ sumPrefix: '$',
503
+ sumSuffix: '',
504
+ avgPrefix: '$',
505
+ avgSuffix: '',
506
+ icon: 'shopify',
507
+ measure: MEASURE.SHOPIFY_LTV_COHORT_NET_SALE_PRICE,
508
+ category: MEASURE_CATEGORY.LTV,
509
+ valueType: MeasureValueType.CURRENCY,
510
+ decimalPlaces: 2,
511
+ useCompactNotation: true,
512
+ applicableContexts: LTV_COHORT_APPLICABLE_CONTEXTS,
513
+ },
514
+ [MEASURE.SHOPIFY_LTV_COHORT_NETT_SALE_PRICE]: {
515
+ title: 'Lifetime Value Cohort Net Sale (plus taxes) Price',
516
+ description: 'The total amount of net sales from a cohort (plus taxes).',
517
+ sumPrefix: '$',
518
+ sumSuffix: '',
519
+ avgPrefix: '$',
520
+ avgSuffix: '',
521
+ icon: 'shopify',
522
+ measure: MEASURE.SHOPIFY_LTV_COHORT_NETT_SALE_PRICE,
523
+ category: MEASURE_CATEGORY.LTV,
524
+ valueType: MeasureValueType.CURRENCY,
525
+ decimalPlaces: 2,
526
+ useCompactNotation: true,
527
+ applicableContexts: LTV_COHORT_APPLICABLE_CONTEXTS,
528
+ },
529
+ [MEASURE.SHOPIFY_LTV_COHORT_NETTS_SALE_PRICE]: {
530
+ title: 'Lifetime Value Cohort Net Sale (plus taxes, shipping) Price',
531
+ description: 'The total amount of net sales from a cohort (plus taxes, shipping).',
532
+ sumPrefix: '$',
533
+ sumSuffix: '',
534
+ avgPrefix: '$',
535
+ avgSuffix: '',
536
+ icon: 'shopify',
537
+ measure: MEASURE.SHOPIFY_LTV_COHORT_NETTS_SALE_PRICE,
538
+ category: MEASURE_CATEGORY.LTV,
539
+ valueType: MeasureValueType.CURRENCY,
540
+ decimalPlaces: 2,
541
+ useCompactNotation: true,
542
+ applicableContexts: LTV_COHORT_APPLICABLE_CONTEXTS,
543
+ },
544
+ [MEASURE.SHOPIFY_LTV_COHORT_NETS_SALE_PRICE]: {
545
+ title: 'Lifetime Value Cohort Net Sale (plus shipping) Price',
546
+ description: 'The total amount of net sales from a cohort (plus shipping).',
547
+ sumPrefix: '$',
548
+ sumSuffix: '',
549
+ avgPrefix: '$',
550
+ avgSuffix: '',
551
+ icon: 'shopify',
552
+ measure: MEASURE.SHOPIFY_LTV_COHORT_NETS_SALE_PRICE,
553
+ category: MEASURE_CATEGORY.LTV,
554
+ valueType: MeasureValueType.CURRENCY,
555
+ decimalPlaces: 2,
556
+ useCompactNotation: true,
557
+ applicableContexts: LTV_COHORT_APPLICABLE_CONTEXTS,
558
+ },
559
+ [MEASURE.SHOPIFY_CUSTOMERS_COHORT]: {
560
+ title: 'Customers Cohort',
561
+ description: 'The number of customers in a cohort.',
562
+ sumPrefix: '',
563
+ sumSuffix: '',
564
+ avgPrefix: '',
565
+ avgSuffix: '',
566
+ icon: 'shopify',
567
+ measure: MEASURE.SHOPIFY_CUSTOMERS_COHORT,
568
+ category: MEASURE_CATEGORY.LTV,
569
+ valueType: MeasureValueType.NUMBER,
570
+ decimalPlaces: 0,
571
+ useCompactNotation: false,
572
+ applicableContexts: LTV_COHORT_APPLICABLE_CONTEXTS,
573
+ },
574
+ [MEASURE.SHOPIFY_CUSTOMERS_RETENTION_RATE_COHORT]: {
575
+ title: 'Customers Retention Rate Cohort',
576
+ description: 'The percentage of customers retained in a cohort.',
577
+ sumPrefix: '',
578
+ sumSuffix: '%',
579
+ avgPrefix: '',
580
+ avgSuffix: '%',
581
+ icon: 'shopify',
582
+ measure: MEASURE.SHOPIFY_CUSTOMERS_RETENTION_RATE_COHORT,
583
+ category: MEASURE_CATEGORY.LTV,
584
+ valueType: MeasureValueType.PERCENTAGE,
585
+ decimalPlaces: 2,
586
+ useCompactNotation: false,
587
+ applicableContexts: LTV_COHORT_APPLICABLE_CONTEXTS,
588
+ },
589
+ [MEASURE.SHOPIFY_AVG_ORDER_VALUE_COHORT]: {
590
+ title: 'Average Order Value Cohort',
591
+ description: 'The average value of an order in a cohort.',
592
+ sumPrefix: '$',
593
+ sumSuffix: '',
594
+ avgPrefix: '$',
595
+ avgSuffix: '',
596
+ icon: 'shopify',
597
+ measure: MEASURE.SHOPIFY_AVG_ORDER_VALUE_COHORT,
598
+ category: MEASURE_CATEGORY.LTV,
599
+ valueType: MeasureValueType.CURRENCY,
600
+ decimalPlaces: 2,
601
+ useCompactNotation: true,
602
+ applicableContexts: LTV_COHORT_APPLICABLE_CONTEXTS,
603
+ },
604
+ [MEASURE.SHOPIFY_REFUND_PLUS_DISCOUNT_AMOUNT]: {
605
+ title: 'Refund Plus Discount Amount',
606
+ description: 'The amount of refunds plus discounts given to all customers.',
607
+ sumPrefix: '$',
608
+ sumSuffix: '',
609
+ avgPrefix: '$',
610
+ avgSuffix: '',
611
+ icon: 'shopify',
612
+ measure: MEASURE.SHOPIFY_REFUND_PLUS_DISCOUNT_AMOUNT,
613
+ category: MEASURE_CATEGORY.SALES,
614
+ valueType: MeasureValueType.CURRENCY,
615
+ decimalPlaces: 2,
616
+ useCompactNotation: true,
617
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
618
+ },
619
+ [MEASURE.SHOPIFY_AVG_ORDERS_PER_CUSTOMER]: {
620
+ title: 'Average Orders per Customer',
621
+ description: 'The average number of orders per customer.',
622
+ sumPrefix: '',
623
+ sumSuffix: '',
624
+ avgPrefix: '',
625
+ avgSuffix: '',
626
+ icon: 'shopify',
627
+ measure: MEASURE.SHOPIFY_AVG_ORDERS_PER_CUSTOMER,
628
+ category: MEASURE_CATEGORY.SALES,
629
+ valueType: MeasureValueType.NUMBER,
630
+ decimalPlaces: 0,
631
+ useCompactNotation: false,
632
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
633
+ },
634
+ [MEASURE.SHOPIFY_ORDER_TOTAL_PRODUCT_COST]: {
635
+ title: 'Order Total Product Cost',
636
+ description: 'The total cost of the products in an order.',
637
+ sumPrefix: '$',
638
+ sumSuffix: '',
639
+ avgPrefix: '$',
640
+ avgSuffix: '',
641
+ icon: 'shopify',
642
+ measure: MEASURE.SHOPIFY_ORDER_TOTAL_PRODUCT_COST,
643
+ category: MEASURE_CATEGORY.SALES,
644
+ valueType: MeasureValueType.CURRENCY,
645
+ decimalPlaces: 2,
646
+ useCompactNotation: true,
647
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
648
+ },
649
+ [MEASURE.SHOPIFY_ORDER_TOTAL_PRODUCT_COST_GROSS_PERCENT]: {
650
+ title: 'Order Total Product Cost (% of Gross Sales)',
651
+ description: 'The percentage of gross sales that represents the total product cost.',
652
+ sumPrefix: '',
653
+ sumSuffix: '%',
654
+ avgPrefix: '',
655
+ avgSuffix: '%',
656
+ icon: 'shopify',
657
+ measure: MEASURE.SHOPIFY_ORDER_TOTAL_PRODUCT_COST_GROSS_PERCENT,
658
+ category: MEASURE_CATEGORY.SALES,
659
+ valueType: MeasureValueType.PERCENTAGE,
660
+ decimalPlaces: 2,
661
+ useCompactNotation: false,
662
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
663
+ },
664
+ [MEASURE.SHOPIFY_ORDER_TOTAL_PRODUCT_COST_NET_PERCENT]: {
665
+ title: 'Order Total Product Cost (% of Net Sales)',
666
+ description: 'The percentage of net sales that represents the total product cost.',
667
+ sumPrefix: '',
668
+ sumSuffix: '%',
669
+ avgPrefix: '',
670
+ avgSuffix: '%',
671
+ icon: 'shopify',
672
+ measure: MEASURE.SHOPIFY_ORDER_TOTAL_PRODUCT_COST_NET_PERCENT,
673
+ category: MEASURE_CATEGORY.SALES,
674
+ valueType: MeasureValueType.PERCENTAGE,
675
+ decimalPlaces: 2,
676
+ useCompactNotation: false,
677
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
678
+ },
679
+ [MEASURE.SHOPIFY_GROSS_PRODUCT_MARGIN]: {
680
+ title: 'Gross Product Margin',
681
+ description: 'Shopify gross margin (Gross Sales - Total Product Cost)',
682
+ sumPrefix: '$',
683
+ sumSuffix: '',
684
+ avgPrefix: '$',
685
+ avgSuffix: '',
686
+ icon: 'shopify',
687
+ measure: MEASURE.SHOPIFY_GROSS_PRODUCT_MARGIN,
688
+ category: MEASURE_CATEGORY.SALES,
689
+ valueType: MeasureValueType.CURRENCY,
690
+ decimalPlaces: 2,
691
+ useCompactNotation: true,
692
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
693
+ },
694
+ [MEASURE.SHOPIFY_GROSS_PRODUCT_MARGIN_GROSS_PERCENT]: {
695
+ title: 'Gross Product Margin (% of Gross Sales)',
696
+ description: 'The percentage of gross sales that represents the gross product margin.',
697
+ sumPrefix: '',
698
+ sumSuffix: '%',
699
+ avgPrefix: '',
700
+ avgSuffix: '%',
701
+ icon: 'shopify',
702
+ measure: MEASURE.SHOPIFY_GROSS_PRODUCT_MARGIN_GROSS_PERCENT,
703
+ category: MEASURE_CATEGORY.SALES,
704
+ valueType: MeasureValueType.PERCENTAGE,
705
+ decimalPlaces: 2,
706
+ useCompactNotation: false,
707
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
708
+ },
709
+ [MEASURE.SHOPIFY_GROSS_PRODUCT_MARGIN_NET_PERCENT]: {
710
+ title: 'Gross Product Margin (% of Net Sales)',
711
+ description: 'The percentage of net sales that represents the gross product margin.',
712
+ sumPrefix: '',
713
+ sumSuffix: '%',
714
+ avgPrefix: '',
715
+ avgSuffix: '%',
716
+ icon: 'shopify',
717
+ measure: MEASURE.SHOPIFY_GROSS_PRODUCT_MARGIN_NET_PERCENT,
718
+ category: MEASURE_CATEGORY.SALES,
719
+ valueType: MeasureValueType.PERCENTAGE,
720
+ decimalPlaces: 2,
721
+ useCompactNotation: false,
722
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
723
+ },
724
+ [MEASURE.SHOPIFY_NET_PRODUCT_MARGIN]: {
725
+ title: 'Net Product Margin',
726
+ description: 'Shopify net margin (Net Sales - Total Product Cost)',
727
+ sumPrefix: '$',
728
+ sumSuffix: '',
729
+ avgPrefix: '$',
730
+ avgSuffix: '',
731
+ icon: 'shopify',
732
+ measure: MEASURE.SHOPIFY_NET_PRODUCT_MARGIN,
733
+ category: MEASURE_CATEGORY.SALES,
734
+ valueType: MeasureValueType.CURRENCY,
735
+ decimalPlaces: 2,
736
+ useCompactNotation: true,
737
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
738
+ },
739
+ [MEASURE.SHOPIFY_NET_PRODUCT_MARGIN_GROSS_PERCENT]: {
740
+ title: 'Net Product Margin (% of Gross Sales)',
741
+ description: 'The percentage of gross sales that represents the net product margin.',
742
+ sumPrefix: '',
743
+ sumSuffix: '%',
744
+ avgPrefix: '',
745
+ avgSuffix: '%',
746
+ icon: 'shopify',
747
+ measure: MEASURE.SHOPIFY_NET_PRODUCT_MARGIN_GROSS_PERCENT,
748
+ category: MEASURE_CATEGORY.SALES,
749
+ valueType: MeasureValueType.PERCENTAGE,
750
+ decimalPlaces: 2,
751
+ useCompactNotation: false,
752
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
753
+ },
754
+ [MEASURE.SHOPIFY_NET_PRODUCT_MARGIN_NET_PERCENT]: {
755
+ title: 'Net Product Margin (% of Net Sales)',
756
+ description: 'The percentage of net sales that represents the net product margin.',
757
+ sumPrefix: '',
758
+ sumSuffix: '%',
759
+ avgPrefix: '',
760
+ avgSuffix: '%',
761
+ icon: 'shopify',
762
+ measure: MEASURE.SHOPIFY_NET_PRODUCT_MARGIN_NET_PERCENT,
763
+ category: MEASURE_CATEGORY.SALES,
764
+ valueType: MeasureValueType.PERCENTAGE,
765
+ decimalPlaces: 2,
766
+ useCompactNotation: false,
767
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
768
+ },
769
+ [MEASURE.SHOPIFY_GROSS_MARGIN]: {
770
+ title: 'Gross Margin',
771
+ description: 'Shopify gross margin (Gross Sales - Total Product Cost - Ad Spend)',
772
+ sumPrefix: '$',
773
+ sumSuffix: '',
774
+ avgPrefix: '$',
775
+ avgSuffix: '',
776
+ icon: 'shopify',
777
+ measure: MEASURE.SHOPIFY_GROSS_MARGIN,
778
+ category: MEASURE_CATEGORY.SALES,
779
+ valueType: MeasureValueType.CURRENCY,
780
+ decimalPlaces: 2,
781
+ useCompactNotation: true,
782
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
783
+ },
784
+ [MEASURE.SHOPIFY_GROSS_MARGIN_GROSS_PERCENT]: {
785
+ title: 'Gross Margin (% of Gross Sales)',
786
+ description: 'The percentage of gross sales that represents the gross margin.',
787
+ sumPrefix: '',
788
+ sumSuffix: '%',
789
+ avgPrefix: '',
790
+ avgSuffix: '%',
791
+ icon: 'shopify',
792
+ measure: MEASURE.SHOPIFY_GROSS_MARGIN_GROSS_PERCENT,
793
+ category: MEASURE_CATEGORY.SALES,
794
+ valueType: MeasureValueType.PERCENTAGE,
795
+ decimalPlaces: 2,
796
+ useCompactNotation: false,
797
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
798
+ },
799
+ [MEASURE.SHOPIFY_GROSS_MARGIN_NET_PERCENT]: {
800
+ title: 'Gross Margin (% of Net Sales)',
801
+ description: 'The percentage of net sales that represents the gross margin.',
802
+ sumPrefix: '',
803
+ sumSuffix: '%',
804
+ avgPrefix: '',
805
+ avgSuffix: '%',
806
+ icon: 'shopify',
807
+ measure: MEASURE.SHOPIFY_GROSS_MARGIN_NET_PERCENT,
808
+ category: MEASURE_CATEGORY.SALES,
809
+ valueType: MeasureValueType.PERCENTAGE,
810
+ decimalPlaces: 2,
811
+ useCompactNotation: false,
812
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
813
+ },
814
+ [MEASURE.SHOPIFY_NET_MARGIN]: {
815
+ title: 'Net Margin',
816
+ description: 'Shopify net margin (Net Sales - Total Product Cost - Ad Spend)',
817
+ sumPrefix: '$',
818
+ sumSuffix: '',
819
+ avgPrefix: '$',
820
+ avgSuffix: '',
821
+ icon: 'shopify',
822
+ measure: MEASURE.SHOPIFY_NET_MARGIN,
823
+ category: MEASURE_CATEGORY.SALES,
824
+ valueType: MeasureValueType.CURRENCY,
825
+ decimalPlaces: 2,
826
+ useCompactNotation: true,
827
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
828
+ },
829
+ [MEASURE.SHOPIFY_NET_MARGIN_GROSS_PERCENT]: {
830
+ title: 'Net Margin (% of Gross Sales)',
831
+ description: 'The percentage of gross sales that represents the net margin.',
832
+ sumPrefix: '',
833
+ sumSuffix: '%',
834
+ avgPrefix: '',
835
+ avgSuffix: '%',
836
+ icon: 'shopify',
837
+ measure: MEASURE.SHOPIFY_NET_MARGIN_GROSS_PERCENT,
838
+ category: MEASURE_CATEGORY.SALES,
839
+ valueType: MeasureValueType.PERCENTAGE,
840
+ decimalPlaces: 2,
841
+ useCompactNotation: false,
842
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
843
+ },
844
+ [MEASURE.SHOPIFY_NET_MARGIN_NET_PERCENT]: {
845
+ title: 'Net Margin (% of Net Sales)',
846
+ description: 'The percentage of net sales that represents the net margin.',
847
+ sumPrefix: '',
848
+ sumSuffix: '%',
849
+ avgPrefix: '',
850
+ avgSuffix: '%',
851
+ icon: 'shopify',
852
+ measure: MEASURE.SHOPIFY_NET_MARGIN_NET_PERCENT,
853
+ category: MEASURE_CATEGORY.SALES,
854
+ valueType: MeasureValueType.PERCENTAGE,
855
+ decimalPlaces: 2,
856
+ useCompactNotation: false,
857
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS
858
+ },
859
+ ...SHOPIFY_NEW_CUSTOMER_MEASURES_MAP,
860
+ ...SHOPIFY_RETURNING_CUSTOMER_MEASURES_MAP,
861
+ };
862
862
  //# sourceMappingURL=shopify-measure-definitions.js.map