@adtrackify/at-tracking-event-types 3.0.32 → 3.0.33

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 (145) hide show
  1. package/dist/cjs/index.d.ts +1 -1
  2. package/dist/cjs/index.js +17 -17
  3. package/dist/cjs/types/api/account.d.ts +37 -37
  4. package/dist/cjs/types/api/account.js +9 -9
  5. package/dist/cjs/types/api/destination-tracked-events.d.ts +11 -11
  6. package/dist/cjs/types/api/destination-tracked-events.js +3 -3
  7. package/dist/cjs/types/api/destinations/destination-catalog.d.ts +30 -30
  8. package/dist/cjs/types/api/destinations/destination-catalog.js +2 -2
  9. package/dist/cjs/types/api/destinations/destinations.d.ts +73 -73
  10. package/dist/cjs/types/api/destinations/destinations.js +29 -29
  11. package/dist/cjs/types/api/destinations/third-party-destination-configs.d.ts +75 -75
  12. package/dist/cjs/types/api/destinations/third-party-destination-configs.js +9 -9
  13. package/dist/cjs/types/api/event-last-seen.d.ts +6 -6
  14. package/dist/cjs/types/api/event-last-seen.js +2 -2
  15. package/dist/cjs/types/api/event-status.d.ts +18 -18
  16. package/dist/cjs/types/api/event-status.js +9 -9
  17. package/dist/cjs/types/api/index.d.ts +14 -14
  18. package/dist/cjs/types/api/index.js +30 -30
  19. package/dist/cjs/types/api/log-events.d.ts +16 -16
  20. package/dist/cjs/types/api/log-events.js +2 -2
  21. package/dist/cjs/types/api/pixel-setup-health.d.ts +19 -19
  22. package/dist/cjs/types/api/pixel-setup-health.js +2 -2
  23. package/dist/cjs/types/api/query.d.ts +160 -160
  24. package/dist/cjs/types/api/query.js +110 -110
  25. package/dist/cjs/types/api/shopify-app-install.d.ts +47 -47
  26. package/dist/cjs/types/api/shopify-app-install.js +22 -22
  27. package/dist/cjs/types/api/subscription.d.ts +97 -97
  28. package/dist/cjs/types/api/subscription.js +36 -36
  29. package/dist/cjs/types/api/tracking-events.d.ts +11 -14
  30. package/dist/cjs/types/api/tracking-events.js +2 -2
  31. package/dist/cjs/types/api/user.d.ts +13 -13
  32. package/dist/cjs/types/api/user.js +2 -2
  33. package/dist/cjs/types/common/address.d.ts +15 -15
  34. package/dist/cjs/types/common/address.js +2 -2
  35. package/dist/cjs/types/common/currency.d.ts +1 -1
  36. package/dist/cjs/types/common/currency.js +63 -63
  37. package/dist/cjs/types/common/index.d.ts +2 -2
  38. package/dist/cjs/types/common/index.js +18 -18
  39. package/dist/cjs/types/event/base/event-name-enum.d.ts +54 -54
  40. package/dist/cjs/types/event/base/event-name-enum.js +60 -60
  41. package/dist/cjs/types/event/base/event.d.ts +20 -20
  42. package/dist/cjs/types/event/base/event.js +10 -10
  43. package/dist/cjs/types/event/base/index.d.ts +2 -2
  44. package/dist/cjs/types/event/base/index.js +18 -18
  45. package/dist/cjs/types/event/context/event-context-identity.d.ts +17 -17
  46. package/dist/cjs/types/event/context/event-context-identity.js +2 -2
  47. package/dist/cjs/types/event/context/event-context.d.ts +160 -160
  48. package/dist/cjs/types/event/context/event-context.js +2 -2
  49. package/dist/cjs/types/event/context/index.d.ts +2 -2
  50. package/dist/cjs/types/event/context/index.js +18 -18
  51. package/dist/cjs/types/event/index.d.ts +5 -5
  52. package/dist/cjs/types/event/index.js +21 -21
  53. package/dist/cjs/types/event/log-event.d.ts +35 -35
  54. package/dist/cjs/types/event/log-event.js +22 -22
  55. package/dist/cjs/types/event/metric-event.d.ts +13 -13
  56. package/dist/cjs/types/event/metric-event.js +2 -2
  57. package/dist/cjs/types/event/tracking-event.d.ts +62 -64
  58. package/dist/cjs/types/event/tracking-event.js +2 -2
  59. package/dist/cjs/types/event-bus-event.d.ts +25 -25
  60. package/dist/cjs/types/event-bus-event.js +2 -2
  61. package/dist/cjs/types/fingerprint/browser-attributes.d.ts +60 -60
  62. package/dist/cjs/types/fingerprint/browser-attributes.js +2 -2
  63. package/dist/cjs/types/fingerprint/index.d.ts +6 -6
  64. package/dist/cjs/types/fingerprint/index.js +18 -18
  65. package/dist/cjs/types/fingerprint/server-attributes.d.ts +50 -50
  66. package/dist/cjs/types/fingerprint/server-attributes.js +2 -2
  67. package/dist/cjs/types/index.d.ts +7 -7
  68. package/dist/cjs/types/index.js +23 -23
  69. package/dist/cjs/types/third-party-event-configuration-types.d.ts +10 -10
  70. package/dist/cjs/types/third-party-event-configuration-types.js +2 -2
  71. package/dist/cjs/types/tracking-event-ingest-message.d.ts +10 -10
  72. package/dist/cjs/types/tracking-event-ingest-message.js +2 -2
  73. package/dist/esm/index.d.ts +1 -1
  74. package/dist/esm/index.js +1 -1
  75. package/dist/esm/types/api/account.d.ts +37 -37
  76. package/dist/esm/types/api/account.js +6 -6
  77. package/dist/esm/types/api/destination-tracked-events.d.ts +11 -11
  78. package/dist/esm/types/api/destination-tracked-events.js +1 -1
  79. package/dist/esm/types/api/destinations/destination-catalog.d.ts +30 -30
  80. package/dist/esm/types/api/destinations/destination-catalog.js +1 -1
  81. package/dist/esm/types/api/destinations/destinations.d.ts +73 -73
  82. package/dist/esm/types/api/destinations/destinations.js +26 -26
  83. package/dist/esm/types/api/destinations/third-party-destination-configs.d.ts +75 -75
  84. package/dist/esm/types/api/destinations/third-party-destination-configs.js +6 -6
  85. package/dist/esm/types/api/event-last-seen.d.ts +6 -6
  86. package/dist/esm/types/api/event-last-seen.js +1 -1
  87. package/dist/esm/types/api/event-status.d.ts +18 -18
  88. package/dist/esm/types/api/event-status.js +6 -6
  89. package/dist/esm/types/api/index.d.ts +14 -14
  90. package/dist/esm/types/api/index.js +14 -14
  91. package/dist/esm/types/api/log-events.d.ts +16 -16
  92. package/dist/esm/types/api/log-events.js +1 -1
  93. package/dist/esm/types/api/pixel-setup-health.d.ts +19 -19
  94. package/dist/esm/types/api/pixel-setup-health.js +1 -1
  95. package/dist/esm/types/api/query.d.ts +160 -160
  96. package/dist/esm/types/api/query.js +107 -107
  97. package/dist/esm/types/api/shopify-app-install.d.ts +47 -47
  98. package/dist/esm/types/api/shopify-app-install.js +19 -19
  99. package/dist/esm/types/api/subscription.d.ts +97 -97
  100. package/dist/esm/types/api/subscription.js +33 -33
  101. package/dist/esm/types/api/tracking-events.d.ts +11 -14
  102. package/dist/esm/types/api/tracking-events.js +1 -1
  103. package/dist/esm/types/api/user.d.ts +13 -13
  104. package/dist/esm/types/api/user.js +1 -1
  105. package/dist/esm/types/common/address.d.ts +15 -15
  106. package/dist/esm/types/common/address.js +1 -1
  107. package/dist/esm/types/common/currency.d.ts +1 -1
  108. package/dist/esm/types/common/currency.js +60 -60
  109. package/dist/esm/types/common/index.d.ts +2 -2
  110. package/dist/esm/types/common/index.js +2 -2
  111. package/dist/esm/types/event/base/event-name-enum.d.ts +54 -54
  112. package/dist/esm/types/event/base/event-name-enum.js +57 -57
  113. package/dist/esm/types/event/base/event.d.ts +20 -20
  114. package/dist/esm/types/event/base/event.js +7 -7
  115. package/dist/esm/types/event/base/index.d.ts +2 -2
  116. package/dist/esm/types/event/base/index.js +2 -2
  117. package/dist/esm/types/event/context/event-context-identity.d.ts +17 -17
  118. package/dist/esm/types/event/context/event-context-identity.js +1 -1
  119. package/dist/esm/types/event/context/event-context.d.ts +160 -160
  120. package/dist/esm/types/event/context/event-context.js +1 -1
  121. package/dist/esm/types/event/context/index.d.ts +2 -2
  122. package/dist/esm/types/event/context/index.js +2 -2
  123. package/dist/esm/types/event/index.d.ts +5 -5
  124. package/dist/esm/types/event/index.js +5 -5
  125. package/dist/esm/types/event/log-event.d.ts +35 -35
  126. package/dist/esm/types/event/log-event.js +19 -19
  127. package/dist/esm/types/event/metric-event.d.ts +13 -13
  128. package/dist/esm/types/event/metric-event.js +1 -1
  129. package/dist/esm/types/event/tracking-event.d.ts +62 -64
  130. package/dist/esm/types/event/tracking-event.js +1 -1
  131. package/dist/esm/types/event-bus-event.d.ts +25 -25
  132. package/dist/esm/types/event-bus-event.js +1 -1
  133. package/dist/esm/types/fingerprint/browser-attributes.d.ts +60 -60
  134. package/dist/esm/types/fingerprint/browser-attributes.js +1 -1
  135. package/dist/esm/types/fingerprint/index.d.ts +6 -6
  136. package/dist/esm/types/fingerprint/index.js +2 -2
  137. package/dist/esm/types/fingerprint/server-attributes.d.ts +50 -50
  138. package/dist/esm/types/fingerprint/server-attributes.js +1 -1
  139. package/dist/esm/types/index.d.ts +7 -7
  140. package/dist/esm/types/index.js +7 -7
  141. package/dist/esm/types/third-party-event-configuration-types.d.ts +10 -10
  142. package/dist/esm/types/third-party-event-configuration-types.js +1 -1
  143. package/dist/esm/types/tracking-event-ingest-message.d.ts +10 -10
  144. package/dist/esm/types/tracking-event-ingest-message.js +1 -1
  145. package/package.json +1 -1
@@ -1,15 +1,15 @@
1
- export * from './account';
2
- export * from './destinations/destinations';
3
- export * from './destinations/destination-catalog';
4
- export * from './destinations/third-party-destination-configs';
5
- export * from './shopify-app-install';
6
- export * from './subscription';
7
- export * from './user';
8
- export * from './query';
9
- export * from './event-status';
10
- export * from './log-events';
11
- export * from './tracking-events';
12
- export * from './destination-tracked-events';
13
- export * from './pixel-setup-health';
14
- export * from './event-last-seen';
1
+ export * from './account';
2
+ export * from './destinations/destinations';
3
+ export * from './destinations/destination-catalog';
4
+ export * from './destinations/third-party-destination-configs';
5
+ export * from './shopify-app-install';
6
+ export * from './subscription';
7
+ export * from './user';
8
+ export * from './query';
9
+ export * from './event-status';
10
+ export * from './log-events';
11
+ export * from './tracking-events';
12
+ export * from './destination-tracked-events';
13
+ export * from './pixel-setup-health';
14
+ export * from './event-last-seen';
15
15
  //# sourceMappingURL=index.js.map
@@ -1,16 +1,16 @@
1
- import { LogEvent, LogLevel } from '../event';
2
- export interface LogEventRecord {
3
- eventId: string;
4
- pixelId_logLevel: string;
5
- eventName: string;
6
- pixelId: string;
7
- destinationId?: string;
8
- source: string;
9
- service: string;
10
- logLevel: LogLevel;
11
- logMessage: string;
12
- logEvent: LogEvent;
13
- logGroup: string;
14
- collectedAt?: string;
15
- expiredAt: number;
16
- }
1
+ import { LogEvent, LogLevel } from '../event';
2
+ export interface LogEventRecord {
3
+ eventId: string;
4
+ pixelId_logLevel: string;
5
+ eventName: string;
6
+ pixelId: string;
7
+ destinationId?: string;
8
+ source: string;
9
+ service: string;
10
+ logLevel: LogLevel;
11
+ logMessage: string;
12
+ logEvent: LogEvent;
13
+ logGroup: string;
14
+ collectedAt?: string;
15
+ expiredAt: number;
16
+ }
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=log-events.js.map
@@ -1,19 +1,19 @@
1
- export interface PixelSetupHealth {
2
- accountId: string;
3
- healthAttributes: HealthAttributes;
4
- }
5
- export interface HealthAttributes {
6
- noOfDestinations: number;
7
- noOfEnabledDestinations: number;
8
- destinations: DestinationHealth[];
9
- destinationsHealthy: boolean;
10
- themeAppExtensionHealthy: boolean;
11
- conversionPixelHealthy: boolean;
12
- customPixelHealthy: boolean;
13
- }
14
- export interface DestinationHealth {
15
- id: string;
16
- displayName: string;
17
- healthy: boolean;
18
- enabled: boolean;
19
- }
1
+ export interface PixelSetupHealth {
2
+ accountId: string;
3
+ healthAttributes: HealthAttributes;
4
+ }
5
+ export interface HealthAttributes {
6
+ noOfDestinations: number;
7
+ noOfEnabledDestinations: number;
8
+ destinations: DestinationHealth[];
9
+ destinationsHealthy: boolean;
10
+ themeAppExtensionHealthy: boolean;
11
+ conversionPixelHealthy: boolean;
12
+ customPixelHealthy: boolean;
13
+ }
14
+ export interface DestinationHealth {
15
+ id: string;
16
+ displayName: string;
17
+ healthy: boolean;
18
+ enabled: boolean;
19
+ }
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=pixel-setup-health.js.map
@@ -1,160 +1,160 @@
1
- export interface DateRange {
2
- start: string;
3
- end: string;
4
- }
5
- export declare enum GRANULARITY {
6
- NONE = "none",
7
- SECOND = "second",
8
- MINUTE = "minute",
9
- HOUR = "hour",
10
- DAY = "day",
11
- WEEK = "week",
12
- MONTH = "month",
13
- QUARTER = "quarter",
14
- YEAR = "year"
15
- }
16
- export declare enum MEASURE {
17
- TRACKED_PAGE_VIEWS = "tracked.page_views",
18
- TRACKED_VIEW_CONTENTS = "tracked.view_contents",
19
- TRACKED_ADD_TO_CARTS = "tracked.add_to_carts",
20
- TRACKED_INITIATE_CHECKOUTS = "tracked.initiate_checkouts",
21
- TRACKED_PURCHASES = "tracked.purchases",
22
- TRACKED_REVENUE = "tracked.revenue",
23
- TRACKED_SESSION_CONVERSION_RATE = "tracked.session_conversion_rate",
24
- TRACKED_REVENUE_PER_VISITOR = "tracked.revenue_per_visitor",
25
- TRACKED_REVENUE_PER_SESSION = "tracked.revenue_per_session",
26
- TRACKED_UNIQUE_SESSIONS = "tracked.sessions",
27
- TRACKED_UNIQUE_VISITORS = "tracked.visitors",
28
- TRACKED_ADD_TO_CART_RATE = "tracked.add_to_cart_rate",
29
- TRACKED_VIEW_CONTENT_RATE = "tracked.view_content_rate",
30
- TRACKED_INITIATE_CHECKOUT_RATE = "tracked.initiate_checkout_rate",
31
- TRACKED_ATC_TO_IC_RATE = "tracked.atc_to_ic_rate",
32
- TRACKED_IC_TO_PURCHASE_RATE = "tracked.ic_to_purchase_rate",
33
- TRACKED_TOTAL_EVENTS = "tracked.events_processed",
34
- SHOPIFY_CUSTOMERS = "shopify.customers",
35
- SHOPIFY_ABANDONED_CHECKOUTS_VALUE = "shopify.abandoned_checkouts_value",
36
- SHOPIFY_ABANDONED_CHECKOUTS = "shopify.abandoned_checkouts",
37
- SHOPIFY_REFUNDS = "shopify.refunds_count",
38
- SHOPIFY_REFUND_REVENUE = "shopify.refunds_amount",
39
- SHOPIFY_REFUND_RATE = "shopify.refunds_rate",
40
- SHOPIFY_DISCOUNTS = "shopify.discounts_count",
41
- SHOPIFY_DISCOUNT_AMOUNT = "shopify.discount_amount",
42
- SHOPIFY_DISCOUNT_RATE = "shopify.discounts_rate",
43
- SHOPIFY_ORDERS = "shopify.order_count",
44
- SHOPIFY_REVENUE = "shopify.revenue",
45
- SHOPIFY_AOV = "shopify.average_order_value",
46
- SHOPIFY_TOP_PRODUCTS = "shopify.top_products",
47
- SHOPIFY_CUSTOMER_LTV = "shopify.customer_ltv",
48
- SHOPIFY_REPEAT_CUSTOMER_RATE = "shopify.repeat_customer_rate",
49
- SHOPIFY_TAX_AMOUNT = "shopify.tax_amount",
50
- SHOPIFY_SHIPPING_AMOUNT = "shopify.shipping_amount",
51
- SHOPIFY_SUBTOTAL_AMOUNT = "shopify.subtotal_amount",
52
- SHOPIFY_NEW_CUSTOMER_RATE = "shopify.new_customer_rate",
53
- SHOPIFY_RETURNING_CUSTOMER_RATE = "shopify.returning_customer_rate",
54
- SITE_TTFB = "site.ttfb",
55
- SITE_FCP = "site.fcp",
56
- SITE_LCP = "site.lcp",
57
- SITE_TIME_ON_SITE = "site.time_on_site",
58
- FB_CPC = "fb.cpc",
59
- FB_CTR = "fb.ctr",
60
- FB_ROAS = "fb.roas",
61
- FB_SPEND = "fb.spend",
62
- FB_CPA = "fb.cpa",
63
- FB_IMPRESSIONS = "fb.impressions",
64
- FB_CLICKS = "fb.clicks"
65
- }
66
- export interface Query {
67
- pixelId: string;
68
- measures: MEASURE[];
69
- dateRange: DateRange;
70
- compareDateRange?: DateRange;
71
- granularity?: GRANULARITY;
72
- dimensions?: DIMENSION[];
73
- filters?: any[];
74
- timezone?: string;
75
- orderSettings?: OrderSettings;
76
- }
77
- export interface OrderSettings {
78
- countVoidedOrders?: boolean;
79
- countPendingOrders?: boolean;
80
- }
81
- export interface AppliedDimensions {
82
- dimensionName?: string;
83
- dimensionValue?: string;
84
- }
85
- export declare type MeasureDataRow = {
86
- [key: string]: any;
87
- dt?: string;
88
- start?: string;
89
- end?: string;
90
- };
91
- export interface QueryData {
92
- primary?: MeasureDataRow[];
93
- compare?: MeasureDataRow[];
94
- }
95
- export interface MeasureDetail {
96
- measure: MEASURE;
97
- isAverage: boolean;
98
- isPercentage: boolean;
99
- calculatedAverage: boolean;
100
- success: boolean;
101
- primaryAvg: number;
102
- compareAvg: number;
103
- primarySum: number;
104
- compareSum: number;
105
- percentDiff: number;
106
- }
107
- export interface QueryResult {
108
- granularity: GRANULARITY;
109
- dimensions: DIMENSION[];
110
- dateRange: DateRange;
111
- compareDateRange?: DateRange;
112
- measureDetails: MeasureDetail[] | null;
113
- data: QueryData | null;
114
- }
115
- export interface QueryResponse {
116
- results: QueryResult[];
117
- }
118
- export declare enum DIMENSION {
119
- DEVICE_MODEL = "device_model",
120
- DEVICE_VENDOR = "device_vendor",
121
- DEVICE_TYPE = "device_type",
122
- BROWSER = "browser",
123
- BROWSER_VERSION = "browser_version",
124
- BROWSER_OS = "browser_os",
125
- OS = "OS",
126
- LANDING_PATH = "landing_path",
127
- PAGE_PATH = "path",
128
- PAGE_TITLE = "title",
129
- QUERY_STRING = "query",
130
- GATEWAY = "gateway",
131
- CURRENCY = "currency",
132
- SHIPPING_CODE = "shipping_code",
133
- IS_MOBILE = "is_mobile",
134
- IS_WIRELESS = "is_wireless",
135
- CITY = "city",
136
- PROVINCE_CODE = "province_code",
137
- PROVINCE = "province",
138
- COUNTRY_CODE = "country_code",
139
- COUNTRY = "country",
140
- POSTAL_CODE = "postal_code",
141
- FINANCIAL_STATUS = "financial_status",
142
- FULFILLMENT_STATUS = "fulfillment_status",
143
- DISCOUNT_CODE = "discount_code",
144
- REFERRER = "referrer",
145
- REFERRER_MEDIUM = "referrer_medium",
146
- REFERRER_SOURCE = "referrer_source",
147
- REFERRER_TERM = "referrer_term",
148
- UTM_CAMPAIGN = "utm_campaign",
149
- UTM_SOURCE = "utm_source",
150
- UTM_MEDIUM = "utm_medium",
151
- UTM_TERM = "utm_term",
152
- UTM_CONTENT = "utm_content",
153
- CLICK_NETWORK = "click_network",
154
- ADBLOCK_DETECTED = "adblock_detected",
155
- TIMEZONE = "timezone",
156
- LOCALE = "locale",
157
- CAMPAIGN = "campaign",
158
- ADSET = "adset",
159
- AD = "ad"
160
- }
1
+ export interface DateRange {
2
+ start: string;
3
+ end: string;
4
+ }
5
+ export declare enum GRANULARITY {
6
+ NONE = "none",
7
+ SECOND = "second",
8
+ MINUTE = "minute",
9
+ HOUR = "hour",
10
+ DAY = "day",
11
+ WEEK = "week",
12
+ MONTH = "month",
13
+ QUARTER = "quarter",
14
+ YEAR = "year"
15
+ }
16
+ export declare enum MEASURE {
17
+ TRACKED_PAGE_VIEWS = "tracked.page_views",
18
+ TRACKED_VIEW_CONTENTS = "tracked.view_contents",
19
+ TRACKED_ADD_TO_CARTS = "tracked.add_to_carts",
20
+ TRACKED_INITIATE_CHECKOUTS = "tracked.initiate_checkouts",
21
+ TRACKED_PURCHASES = "tracked.purchases",
22
+ TRACKED_REVENUE = "tracked.revenue",
23
+ TRACKED_SESSION_CONVERSION_RATE = "tracked.session_conversion_rate",
24
+ TRACKED_REVENUE_PER_VISITOR = "tracked.revenue_per_visitor",
25
+ TRACKED_REVENUE_PER_SESSION = "tracked.revenue_per_session",
26
+ TRACKED_UNIQUE_SESSIONS = "tracked.sessions",
27
+ TRACKED_UNIQUE_VISITORS = "tracked.visitors",
28
+ TRACKED_ADD_TO_CART_RATE = "tracked.add_to_cart_rate",
29
+ TRACKED_VIEW_CONTENT_RATE = "tracked.view_content_rate",
30
+ TRACKED_INITIATE_CHECKOUT_RATE = "tracked.initiate_checkout_rate",
31
+ TRACKED_ATC_TO_IC_RATE = "tracked.atc_to_ic_rate",
32
+ TRACKED_IC_TO_PURCHASE_RATE = "tracked.ic_to_purchase_rate",
33
+ TRACKED_TOTAL_EVENTS = "tracked.events_processed",
34
+ SHOPIFY_CUSTOMERS = "shopify.customers",
35
+ SHOPIFY_ABANDONED_CHECKOUTS_VALUE = "shopify.abandoned_checkouts_value",
36
+ SHOPIFY_ABANDONED_CHECKOUTS = "shopify.abandoned_checkouts",
37
+ SHOPIFY_REFUNDS = "shopify.refunds_count",
38
+ SHOPIFY_REFUND_REVENUE = "shopify.refunds_amount",
39
+ SHOPIFY_REFUND_RATE = "shopify.refunds_rate",
40
+ SHOPIFY_DISCOUNTS = "shopify.discounts_count",
41
+ SHOPIFY_DISCOUNT_AMOUNT = "shopify.discount_amount",
42
+ SHOPIFY_DISCOUNT_RATE = "shopify.discounts_rate",
43
+ SHOPIFY_ORDERS = "shopify.order_count",
44
+ SHOPIFY_REVENUE = "shopify.revenue",
45
+ SHOPIFY_AOV = "shopify.average_order_value",
46
+ SHOPIFY_TOP_PRODUCTS = "shopify.top_products",
47
+ SHOPIFY_CUSTOMER_LTV = "shopify.customer_ltv",
48
+ SHOPIFY_REPEAT_CUSTOMER_RATE = "shopify.repeat_customer_rate",
49
+ SHOPIFY_TAX_AMOUNT = "shopify.tax_amount",
50
+ SHOPIFY_SHIPPING_AMOUNT = "shopify.shipping_amount",
51
+ SHOPIFY_SUBTOTAL_AMOUNT = "shopify.subtotal_amount",
52
+ SHOPIFY_NEW_CUSTOMER_RATE = "shopify.new_customer_rate",
53
+ SHOPIFY_RETURNING_CUSTOMER_RATE = "shopify.returning_customer_rate",
54
+ SITE_TTFB = "site.ttfb",
55
+ SITE_FCP = "site.fcp",
56
+ SITE_LCP = "site.lcp",
57
+ SITE_TIME_ON_SITE = "site.time_on_site",
58
+ FB_CPC = "fb.cpc",
59
+ FB_CTR = "fb.ctr",
60
+ FB_ROAS = "fb.roas",
61
+ FB_SPEND = "fb.spend",
62
+ FB_CPA = "fb.cpa",
63
+ FB_IMPRESSIONS = "fb.impressions",
64
+ FB_CLICKS = "fb.clicks"
65
+ }
66
+ export interface Query {
67
+ pixelId: string;
68
+ measures: MEASURE[];
69
+ dateRange: DateRange;
70
+ compareDateRange?: DateRange;
71
+ granularity?: GRANULARITY;
72
+ dimensions?: DIMENSION[];
73
+ filters?: any[];
74
+ timezone?: string;
75
+ orderSettings?: OrderSettings;
76
+ }
77
+ export interface OrderSettings {
78
+ countVoidedOrders?: boolean;
79
+ countPendingOrders?: boolean;
80
+ }
81
+ export interface AppliedDimensions {
82
+ dimensionName?: string;
83
+ dimensionValue?: string;
84
+ }
85
+ export declare type MeasureDataRow = {
86
+ [key: string]: any;
87
+ dt?: string;
88
+ start?: string;
89
+ end?: string;
90
+ };
91
+ export interface QueryData {
92
+ primary?: MeasureDataRow[];
93
+ compare?: MeasureDataRow[];
94
+ }
95
+ export interface MeasureDetail {
96
+ measure: MEASURE;
97
+ isAverage: boolean;
98
+ isPercentage: boolean;
99
+ calculatedAverage: boolean;
100
+ success: boolean;
101
+ primaryAvg: number;
102
+ compareAvg: number;
103
+ primarySum: number;
104
+ compareSum: number;
105
+ percentDiff: number;
106
+ }
107
+ export interface QueryResult {
108
+ granularity: GRANULARITY;
109
+ dimensions: DIMENSION[];
110
+ dateRange: DateRange;
111
+ compareDateRange?: DateRange;
112
+ measureDetails: MeasureDetail[] | null;
113
+ data: QueryData | null;
114
+ }
115
+ export interface QueryResponse {
116
+ results: QueryResult[];
117
+ }
118
+ export declare enum DIMENSION {
119
+ DEVICE_MODEL = "device_model",
120
+ DEVICE_VENDOR = "device_vendor",
121
+ DEVICE_TYPE = "device_type",
122
+ BROWSER = "browser",
123
+ BROWSER_VERSION = "browser_version",
124
+ BROWSER_OS = "browser_os",
125
+ OS = "OS",
126
+ LANDING_PATH = "landing_path",
127
+ PAGE_PATH = "path",
128
+ PAGE_TITLE = "title",
129
+ QUERY_STRING = "query",
130
+ GATEWAY = "gateway",
131
+ CURRENCY = "currency",
132
+ SHIPPING_CODE = "shipping_code",
133
+ IS_MOBILE = "is_mobile",
134
+ IS_WIRELESS = "is_wireless",
135
+ CITY = "city",
136
+ PROVINCE_CODE = "province_code",
137
+ PROVINCE = "province",
138
+ COUNTRY_CODE = "country_code",
139
+ COUNTRY = "country",
140
+ POSTAL_CODE = "postal_code",
141
+ FINANCIAL_STATUS = "financial_status",
142
+ FULFILLMENT_STATUS = "fulfillment_status",
143
+ DISCOUNT_CODE = "discount_code",
144
+ REFERRER = "referrer",
145
+ REFERRER_MEDIUM = "referrer_medium",
146
+ REFERRER_SOURCE = "referrer_source",
147
+ REFERRER_TERM = "referrer_term",
148
+ UTM_CAMPAIGN = "utm_campaign",
149
+ UTM_SOURCE = "utm_source",
150
+ UTM_MEDIUM = "utm_medium",
151
+ UTM_TERM = "utm_term",
152
+ UTM_CONTENT = "utm_content",
153
+ CLICK_NETWORK = "click_network",
154
+ ADBLOCK_DETECTED = "adblock_detected",
155
+ TIMEZONE = "timezone",
156
+ LOCALE = "locale",
157
+ CAMPAIGN = "campaign",
158
+ ADSET = "adset",
159
+ AD = "ad"
160
+ }
@@ -1,108 +1,108 @@
1
- export var GRANULARITY;
2
- (function (GRANULARITY) {
3
- GRANULARITY["NONE"] = "none";
4
- GRANULARITY["SECOND"] = "second";
5
- GRANULARITY["MINUTE"] = "minute";
6
- GRANULARITY["HOUR"] = "hour";
7
- GRANULARITY["DAY"] = "day";
8
- GRANULARITY["WEEK"] = "week";
9
- GRANULARITY["MONTH"] = "month";
10
- GRANULARITY["QUARTER"] = "quarter";
11
- GRANULARITY["YEAR"] = "year";
12
- })(GRANULARITY || (GRANULARITY = {}));
13
- export var MEASURE;
14
- (function (MEASURE) {
15
- MEASURE["TRACKED_PAGE_VIEWS"] = "tracked.page_views";
16
- MEASURE["TRACKED_VIEW_CONTENTS"] = "tracked.view_contents";
17
- MEASURE["TRACKED_ADD_TO_CARTS"] = "tracked.add_to_carts";
18
- MEASURE["TRACKED_INITIATE_CHECKOUTS"] = "tracked.initiate_checkouts";
19
- MEASURE["TRACKED_PURCHASES"] = "tracked.purchases";
20
- MEASURE["TRACKED_REVENUE"] = "tracked.revenue";
21
- MEASURE["TRACKED_SESSION_CONVERSION_RATE"] = "tracked.session_conversion_rate";
22
- MEASURE["TRACKED_REVENUE_PER_VISITOR"] = "tracked.revenue_per_visitor";
23
- MEASURE["TRACKED_REVENUE_PER_SESSION"] = "tracked.revenue_per_session";
24
- MEASURE["TRACKED_UNIQUE_SESSIONS"] = "tracked.sessions";
25
- MEASURE["TRACKED_UNIQUE_VISITORS"] = "tracked.visitors";
26
- MEASURE["TRACKED_ADD_TO_CART_RATE"] = "tracked.add_to_cart_rate";
27
- MEASURE["TRACKED_VIEW_CONTENT_RATE"] = "tracked.view_content_rate";
28
- MEASURE["TRACKED_INITIATE_CHECKOUT_RATE"] = "tracked.initiate_checkout_rate";
29
- MEASURE["TRACKED_ATC_TO_IC_RATE"] = "tracked.atc_to_ic_rate";
30
- MEASURE["TRACKED_IC_TO_PURCHASE_RATE"] = "tracked.ic_to_purchase_rate";
31
- MEASURE["TRACKED_TOTAL_EVENTS"] = "tracked.events_processed";
32
- MEASURE["SHOPIFY_CUSTOMERS"] = "shopify.customers";
33
- MEASURE["SHOPIFY_ABANDONED_CHECKOUTS_VALUE"] = "shopify.abandoned_checkouts_value";
34
- MEASURE["SHOPIFY_ABANDONED_CHECKOUTS"] = "shopify.abandoned_checkouts";
35
- MEASURE["SHOPIFY_REFUNDS"] = "shopify.refunds_count";
36
- MEASURE["SHOPIFY_REFUND_REVENUE"] = "shopify.refunds_amount";
37
- MEASURE["SHOPIFY_REFUND_RATE"] = "shopify.refunds_rate";
38
- MEASURE["SHOPIFY_DISCOUNTS"] = "shopify.discounts_count";
39
- MEASURE["SHOPIFY_DISCOUNT_AMOUNT"] = "shopify.discount_amount";
40
- MEASURE["SHOPIFY_DISCOUNT_RATE"] = "shopify.discounts_rate";
41
- MEASURE["SHOPIFY_ORDERS"] = "shopify.order_count";
42
- MEASURE["SHOPIFY_REVENUE"] = "shopify.revenue";
43
- MEASURE["SHOPIFY_AOV"] = "shopify.average_order_value";
44
- MEASURE["SHOPIFY_TOP_PRODUCTS"] = "shopify.top_products";
45
- MEASURE["SHOPIFY_CUSTOMER_LTV"] = "shopify.customer_ltv";
46
- MEASURE["SHOPIFY_REPEAT_CUSTOMER_RATE"] = "shopify.repeat_customer_rate";
47
- MEASURE["SHOPIFY_TAX_AMOUNT"] = "shopify.tax_amount";
48
- MEASURE["SHOPIFY_SHIPPING_AMOUNT"] = "shopify.shipping_amount";
49
- MEASURE["SHOPIFY_SUBTOTAL_AMOUNT"] = "shopify.subtotal_amount";
50
- MEASURE["SHOPIFY_NEW_CUSTOMER_RATE"] = "shopify.new_customer_rate";
51
- MEASURE["SHOPIFY_RETURNING_CUSTOMER_RATE"] = "shopify.returning_customer_rate";
52
- MEASURE["SITE_TTFB"] = "site.ttfb";
53
- MEASURE["SITE_FCP"] = "site.fcp";
54
- MEASURE["SITE_LCP"] = "site.lcp";
55
- MEASURE["SITE_TIME_ON_SITE"] = "site.time_on_site";
56
- MEASURE["FB_CPC"] = "fb.cpc";
57
- MEASURE["FB_CTR"] = "fb.ctr";
58
- MEASURE["FB_ROAS"] = "fb.roas";
59
- MEASURE["FB_SPEND"] = "fb.spend";
60
- MEASURE["FB_CPA"] = "fb.cpa";
61
- MEASURE["FB_IMPRESSIONS"] = "fb.impressions";
62
- MEASURE["FB_CLICKS"] = "fb.clicks";
63
- })(MEASURE || (MEASURE = {}));
64
- export var DIMENSION;
65
- (function (DIMENSION) {
66
- DIMENSION["DEVICE_MODEL"] = "device_model";
67
- DIMENSION["DEVICE_VENDOR"] = "device_vendor";
68
- DIMENSION["DEVICE_TYPE"] = "device_type";
69
- DIMENSION["BROWSER"] = "browser";
70
- DIMENSION["BROWSER_VERSION"] = "browser_version";
71
- DIMENSION["BROWSER_OS"] = "browser_os";
72
- DIMENSION["OS"] = "OS";
73
- DIMENSION["LANDING_PATH"] = "landing_path";
74
- DIMENSION["PAGE_PATH"] = "path";
75
- DIMENSION["PAGE_TITLE"] = "title";
76
- DIMENSION["QUERY_STRING"] = "query";
77
- DIMENSION["GATEWAY"] = "gateway";
78
- DIMENSION["CURRENCY"] = "currency";
79
- DIMENSION["SHIPPING_CODE"] = "shipping_code";
80
- DIMENSION["IS_MOBILE"] = "is_mobile";
81
- DIMENSION["IS_WIRELESS"] = "is_wireless";
82
- DIMENSION["CITY"] = "city";
83
- DIMENSION["PROVINCE_CODE"] = "province_code";
84
- DIMENSION["PROVINCE"] = "province";
85
- DIMENSION["COUNTRY_CODE"] = "country_code";
86
- DIMENSION["COUNTRY"] = "country";
87
- DIMENSION["POSTAL_CODE"] = "postal_code";
88
- DIMENSION["FINANCIAL_STATUS"] = "financial_status";
89
- DIMENSION["FULFILLMENT_STATUS"] = "fulfillment_status";
90
- DIMENSION["DISCOUNT_CODE"] = "discount_code";
91
- DIMENSION["REFERRER"] = "referrer";
92
- DIMENSION["REFERRER_MEDIUM"] = "referrer_medium";
93
- DIMENSION["REFERRER_SOURCE"] = "referrer_source";
94
- DIMENSION["REFERRER_TERM"] = "referrer_term";
95
- DIMENSION["UTM_CAMPAIGN"] = "utm_campaign";
96
- DIMENSION["UTM_SOURCE"] = "utm_source";
97
- DIMENSION["UTM_MEDIUM"] = "utm_medium";
98
- DIMENSION["UTM_TERM"] = "utm_term";
99
- DIMENSION["UTM_CONTENT"] = "utm_content";
100
- DIMENSION["CLICK_NETWORK"] = "click_network";
101
- DIMENSION["ADBLOCK_DETECTED"] = "adblock_detected";
102
- DIMENSION["TIMEZONE"] = "timezone";
103
- DIMENSION["LOCALE"] = "locale";
104
- DIMENSION["CAMPAIGN"] = "campaign";
105
- DIMENSION["ADSET"] = "adset";
106
- DIMENSION["AD"] = "ad";
107
- })(DIMENSION || (DIMENSION = {}));
1
+ export var GRANULARITY;
2
+ (function (GRANULARITY) {
3
+ GRANULARITY["NONE"] = "none";
4
+ GRANULARITY["SECOND"] = "second";
5
+ GRANULARITY["MINUTE"] = "minute";
6
+ GRANULARITY["HOUR"] = "hour";
7
+ GRANULARITY["DAY"] = "day";
8
+ GRANULARITY["WEEK"] = "week";
9
+ GRANULARITY["MONTH"] = "month";
10
+ GRANULARITY["QUARTER"] = "quarter";
11
+ GRANULARITY["YEAR"] = "year";
12
+ })(GRANULARITY || (GRANULARITY = {}));
13
+ export var MEASURE;
14
+ (function (MEASURE) {
15
+ MEASURE["TRACKED_PAGE_VIEWS"] = "tracked.page_views";
16
+ MEASURE["TRACKED_VIEW_CONTENTS"] = "tracked.view_contents";
17
+ MEASURE["TRACKED_ADD_TO_CARTS"] = "tracked.add_to_carts";
18
+ MEASURE["TRACKED_INITIATE_CHECKOUTS"] = "tracked.initiate_checkouts";
19
+ MEASURE["TRACKED_PURCHASES"] = "tracked.purchases";
20
+ MEASURE["TRACKED_REVENUE"] = "tracked.revenue";
21
+ MEASURE["TRACKED_SESSION_CONVERSION_RATE"] = "tracked.session_conversion_rate";
22
+ MEASURE["TRACKED_REVENUE_PER_VISITOR"] = "tracked.revenue_per_visitor";
23
+ MEASURE["TRACKED_REVENUE_PER_SESSION"] = "tracked.revenue_per_session";
24
+ MEASURE["TRACKED_UNIQUE_SESSIONS"] = "tracked.sessions";
25
+ MEASURE["TRACKED_UNIQUE_VISITORS"] = "tracked.visitors";
26
+ MEASURE["TRACKED_ADD_TO_CART_RATE"] = "tracked.add_to_cart_rate";
27
+ MEASURE["TRACKED_VIEW_CONTENT_RATE"] = "tracked.view_content_rate";
28
+ MEASURE["TRACKED_INITIATE_CHECKOUT_RATE"] = "tracked.initiate_checkout_rate";
29
+ MEASURE["TRACKED_ATC_TO_IC_RATE"] = "tracked.atc_to_ic_rate";
30
+ MEASURE["TRACKED_IC_TO_PURCHASE_RATE"] = "tracked.ic_to_purchase_rate";
31
+ MEASURE["TRACKED_TOTAL_EVENTS"] = "tracked.events_processed";
32
+ MEASURE["SHOPIFY_CUSTOMERS"] = "shopify.customers";
33
+ MEASURE["SHOPIFY_ABANDONED_CHECKOUTS_VALUE"] = "shopify.abandoned_checkouts_value";
34
+ MEASURE["SHOPIFY_ABANDONED_CHECKOUTS"] = "shopify.abandoned_checkouts";
35
+ MEASURE["SHOPIFY_REFUNDS"] = "shopify.refunds_count";
36
+ MEASURE["SHOPIFY_REFUND_REVENUE"] = "shopify.refunds_amount";
37
+ MEASURE["SHOPIFY_REFUND_RATE"] = "shopify.refunds_rate";
38
+ MEASURE["SHOPIFY_DISCOUNTS"] = "shopify.discounts_count";
39
+ MEASURE["SHOPIFY_DISCOUNT_AMOUNT"] = "shopify.discount_amount";
40
+ MEASURE["SHOPIFY_DISCOUNT_RATE"] = "shopify.discounts_rate";
41
+ MEASURE["SHOPIFY_ORDERS"] = "shopify.order_count";
42
+ MEASURE["SHOPIFY_REVENUE"] = "shopify.revenue";
43
+ MEASURE["SHOPIFY_AOV"] = "shopify.average_order_value";
44
+ MEASURE["SHOPIFY_TOP_PRODUCTS"] = "shopify.top_products";
45
+ MEASURE["SHOPIFY_CUSTOMER_LTV"] = "shopify.customer_ltv";
46
+ MEASURE["SHOPIFY_REPEAT_CUSTOMER_RATE"] = "shopify.repeat_customer_rate";
47
+ MEASURE["SHOPIFY_TAX_AMOUNT"] = "shopify.tax_amount";
48
+ MEASURE["SHOPIFY_SHIPPING_AMOUNT"] = "shopify.shipping_amount";
49
+ MEASURE["SHOPIFY_SUBTOTAL_AMOUNT"] = "shopify.subtotal_amount";
50
+ MEASURE["SHOPIFY_NEW_CUSTOMER_RATE"] = "shopify.new_customer_rate";
51
+ MEASURE["SHOPIFY_RETURNING_CUSTOMER_RATE"] = "shopify.returning_customer_rate";
52
+ MEASURE["SITE_TTFB"] = "site.ttfb";
53
+ MEASURE["SITE_FCP"] = "site.fcp";
54
+ MEASURE["SITE_LCP"] = "site.lcp";
55
+ MEASURE["SITE_TIME_ON_SITE"] = "site.time_on_site";
56
+ MEASURE["FB_CPC"] = "fb.cpc";
57
+ MEASURE["FB_CTR"] = "fb.ctr";
58
+ MEASURE["FB_ROAS"] = "fb.roas";
59
+ MEASURE["FB_SPEND"] = "fb.spend";
60
+ MEASURE["FB_CPA"] = "fb.cpa";
61
+ MEASURE["FB_IMPRESSIONS"] = "fb.impressions";
62
+ MEASURE["FB_CLICKS"] = "fb.clicks";
63
+ })(MEASURE || (MEASURE = {}));
64
+ export var DIMENSION;
65
+ (function (DIMENSION) {
66
+ DIMENSION["DEVICE_MODEL"] = "device_model";
67
+ DIMENSION["DEVICE_VENDOR"] = "device_vendor";
68
+ DIMENSION["DEVICE_TYPE"] = "device_type";
69
+ DIMENSION["BROWSER"] = "browser";
70
+ DIMENSION["BROWSER_VERSION"] = "browser_version";
71
+ DIMENSION["BROWSER_OS"] = "browser_os";
72
+ DIMENSION["OS"] = "OS";
73
+ DIMENSION["LANDING_PATH"] = "landing_path";
74
+ DIMENSION["PAGE_PATH"] = "path";
75
+ DIMENSION["PAGE_TITLE"] = "title";
76
+ DIMENSION["QUERY_STRING"] = "query";
77
+ DIMENSION["GATEWAY"] = "gateway";
78
+ DIMENSION["CURRENCY"] = "currency";
79
+ DIMENSION["SHIPPING_CODE"] = "shipping_code";
80
+ DIMENSION["IS_MOBILE"] = "is_mobile";
81
+ DIMENSION["IS_WIRELESS"] = "is_wireless";
82
+ DIMENSION["CITY"] = "city";
83
+ DIMENSION["PROVINCE_CODE"] = "province_code";
84
+ DIMENSION["PROVINCE"] = "province";
85
+ DIMENSION["COUNTRY_CODE"] = "country_code";
86
+ DIMENSION["COUNTRY"] = "country";
87
+ DIMENSION["POSTAL_CODE"] = "postal_code";
88
+ DIMENSION["FINANCIAL_STATUS"] = "financial_status";
89
+ DIMENSION["FULFILLMENT_STATUS"] = "fulfillment_status";
90
+ DIMENSION["DISCOUNT_CODE"] = "discount_code";
91
+ DIMENSION["REFERRER"] = "referrer";
92
+ DIMENSION["REFERRER_MEDIUM"] = "referrer_medium";
93
+ DIMENSION["REFERRER_SOURCE"] = "referrer_source";
94
+ DIMENSION["REFERRER_TERM"] = "referrer_term";
95
+ DIMENSION["UTM_CAMPAIGN"] = "utm_campaign";
96
+ DIMENSION["UTM_SOURCE"] = "utm_source";
97
+ DIMENSION["UTM_MEDIUM"] = "utm_medium";
98
+ DIMENSION["UTM_TERM"] = "utm_term";
99
+ DIMENSION["UTM_CONTENT"] = "utm_content";
100
+ DIMENSION["CLICK_NETWORK"] = "click_network";
101
+ DIMENSION["ADBLOCK_DETECTED"] = "adblock_detected";
102
+ DIMENSION["TIMEZONE"] = "timezone";
103
+ DIMENSION["LOCALE"] = "locale";
104
+ DIMENSION["CAMPAIGN"] = "campaign";
105
+ DIMENSION["ADSET"] = "adset";
106
+ DIMENSION["AD"] = "ad";
107
+ })(DIMENSION || (DIMENSION = {}));
108
108
  //# sourceMappingURL=query.js.map