@adtrackify/at-tracking-event-types 2.0.30 → 2.0.31

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 (105) 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 +27 -27
  4. package/dist/cjs/types/api/account.js +9 -9
  5. package/dist/cjs/types/api/destinations/destination-catalog.d.ts +29 -23
  6. package/dist/cjs/types/api/destinations/destination-catalog.js +2 -2
  7. package/dist/cjs/types/api/destinations/destinations.d.ts +58 -58
  8. package/dist/cjs/types/api/destinations/destinations.js +19 -19
  9. package/dist/cjs/types/api/destinations/third-party-destination-configs.d.ts +53 -53
  10. package/dist/cjs/types/api/destinations/third-party-destination-configs.js +9 -9
  11. package/dist/cjs/types/api/index.d.ts +8 -8
  12. package/dist/cjs/types/api/index.js +24 -24
  13. package/dist/cjs/types/api/query.d.ts +143 -143
  14. package/dist/cjs/types/api/query.js +99 -99
  15. package/dist/cjs/types/api/shopify-app-install.d.ts +46 -46
  16. package/dist/cjs/types/api/shopify-app-install.js +21 -21
  17. package/dist/cjs/types/api/subscription.d.ts +60 -60
  18. package/dist/cjs/types/api/subscription.js +31 -31
  19. package/dist/cjs/types/api/user.d.ts +13 -13
  20. package/dist/cjs/types/api/user.js +2 -2
  21. package/dist/cjs/types/common/address.d.ts +15 -15
  22. package/dist/cjs/types/common/address.js +2 -2
  23. package/dist/cjs/types/common/currency.d.ts +1 -1
  24. package/dist/cjs/types/common/currency.js +63 -63
  25. package/dist/cjs/types/common/index.d.ts +2 -2
  26. package/dist/cjs/types/common/index.js +18 -18
  27. package/dist/cjs/types/event/base/event-name-enum.d.ts +36 -36
  28. package/dist/cjs/types/event/base/event-name-enum.js +42 -42
  29. package/dist/cjs/types/event/base/event.d.ts +19 -19
  30. package/dist/cjs/types/event/base/event.js +10 -10
  31. package/dist/cjs/types/event/base/index.d.ts +2 -2
  32. package/dist/cjs/types/event/base/index.js +18 -18
  33. package/dist/cjs/types/event/context/event-context-identity.d.ts +18 -18
  34. package/dist/cjs/types/event/context/event-context-identity.js +2 -2
  35. package/dist/cjs/types/event/context/event-context.d.ts +137 -137
  36. package/dist/cjs/types/event/context/event-context.js +2 -2
  37. package/dist/cjs/types/event/context/index.d.ts +2 -2
  38. package/dist/cjs/types/event/context/index.js +18 -18
  39. package/dist/cjs/types/event/index.d.ts +5 -5
  40. package/dist/cjs/types/event/index.js +21 -21
  41. package/dist/cjs/types/event/log-event.d.ts +37 -37
  42. package/dist/cjs/types/event/log-event.js +18 -18
  43. package/dist/cjs/types/event/metric-event.d.ts +13 -13
  44. package/dist/cjs/types/event/metric-event.js +2 -2
  45. package/dist/cjs/types/event/tracking-event.d.ts +60 -60
  46. package/dist/cjs/types/event/tracking-event.js +2 -2
  47. package/dist/cjs/types/event-bus-event.d.ts +25 -25
  48. package/dist/cjs/types/event-bus-event.js +2 -2
  49. package/dist/cjs/types/index.d.ts +5 -5
  50. package/dist/cjs/types/index.js +21 -21
  51. package/dist/cjs/types/third-party-event-configuration-types.d.ts +9 -9
  52. package/dist/cjs/types/third-party-event-configuration-types.js +2 -2
  53. package/dist/esm/index.d.ts +1 -1
  54. package/dist/esm/index.js +1 -1
  55. package/dist/esm/types/api/account.d.ts +27 -27
  56. package/dist/esm/types/api/account.js +6 -6
  57. package/dist/esm/types/api/destinations/destination-catalog.d.ts +29 -23
  58. package/dist/esm/types/api/destinations/destination-catalog.js +1 -1
  59. package/dist/esm/types/api/destinations/destinations.d.ts +58 -58
  60. package/dist/esm/types/api/destinations/destinations.js +16 -16
  61. package/dist/esm/types/api/destinations/third-party-destination-configs.d.ts +53 -53
  62. package/dist/esm/types/api/destinations/third-party-destination-configs.js +6 -6
  63. package/dist/esm/types/api/index.d.ts +8 -8
  64. package/dist/esm/types/api/index.js +8 -8
  65. package/dist/esm/types/api/query.d.ts +143 -143
  66. package/dist/esm/types/api/query.js +96 -96
  67. package/dist/esm/types/api/shopify-app-install.d.ts +46 -46
  68. package/dist/esm/types/api/shopify-app-install.js +18 -18
  69. package/dist/esm/types/api/subscription.d.ts +60 -60
  70. package/dist/esm/types/api/subscription.js +28 -28
  71. package/dist/esm/types/api/user.d.ts +13 -13
  72. package/dist/esm/types/api/user.js +1 -1
  73. package/dist/esm/types/common/address.d.ts +15 -15
  74. package/dist/esm/types/common/address.js +1 -1
  75. package/dist/esm/types/common/currency.d.ts +1 -1
  76. package/dist/esm/types/common/currency.js +60 -60
  77. package/dist/esm/types/common/index.d.ts +2 -2
  78. package/dist/esm/types/common/index.js +2 -2
  79. package/dist/esm/types/event/base/event-name-enum.d.ts +36 -36
  80. package/dist/esm/types/event/base/event-name-enum.js +39 -39
  81. package/dist/esm/types/event/base/event.d.ts +19 -19
  82. package/dist/esm/types/event/base/event.js +7 -7
  83. package/dist/esm/types/event/base/index.d.ts +2 -2
  84. package/dist/esm/types/event/base/index.js +2 -2
  85. package/dist/esm/types/event/context/event-context-identity.d.ts +18 -18
  86. package/dist/esm/types/event/context/event-context-identity.js +1 -1
  87. package/dist/esm/types/event/context/event-context.d.ts +137 -137
  88. package/dist/esm/types/event/context/event-context.js +1 -1
  89. package/dist/esm/types/event/context/index.d.ts +2 -2
  90. package/dist/esm/types/event/context/index.js +2 -2
  91. package/dist/esm/types/event/index.d.ts +5 -5
  92. package/dist/esm/types/event/index.js +5 -5
  93. package/dist/esm/types/event/log-event.d.ts +37 -37
  94. package/dist/esm/types/event/log-event.js +15 -15
  95. package/dist/esm/types/event/metric-event.d.ts +13 -13
  96. package/dist/esm/types/event/metric-event.js +1 -1
  97. package/dist/esm/types/event/tracking-event.d.ts +60 -60
  98. package/dist/esm/types/event/tracking-event.js +1 -1
  99. package/dist/esm/types/event-bus-event.d.ts +25 -25
  100. package/dist/esm/types/event-bus-event.js +1 -1
  101. package/dist/esm/types/index.d.ts +5 -5
  102. package/dist/esm/types/index.js +5 -5
  103. package/dist/esm/types/third-party-event-configuration-types.d.ts +9 -9
  104. package/dist/esm/types/third-party-event-configuration-types.js +1 -1
  105. package/package.json +2 -2
@@ -1,53 +1,53 @@
1
- import { Destination, UserDestinationConfiguration } from './destinations';
2
- export interface AdTrackifyFacebookDestination extends Destination {
3
- configuration: FacebookPixelConfiguration;
4
- }
5
- export interface AdTrackifyTikTokDestination extends Destination {
6
- configuration: TiktokPixelConfiguration;
7
- }
8
- export interface AdTrackifyGoogleAnalytics4Destination extends Destination {
9
- configuration: GoogleAnalytics4Configuration;
10
- }
11
- export interface FacebookPixelConfiguration extends UserDestinationConfiguration {
12
- apiAccessToken?: string;
13
- enableConversionAPI: boolean;
14
- pixelId: string;
15
- }
16
- export interface TiktokPixelConfiguration extends UserDestinationConfiguration {
17
- apiAccessToken?: string;
18
- enableConversionAPI: boolean;
19
- pixelId: string;
20
- }
21
- export interface GoogleAnalytics4Configuration extends UserDestinationConfiguration {
22
- apiSecret: string;
23
- measurementId: string;
24
- }
25
- export interface GoogleAdsConfiguration extends UserDestinationConfiguration {
26
- pixelId: string;
27
- conversionID: string;
28
- }
29
- export interface HubspotPixelConfiguration extends UserDestinationConfiguration {
30
- hubspotId: string;
31
- }
32
- export interface SnapchatPixelConfiguration extends UserDestinationConfiguration {
33
- snapchatPixelId: string;
34
- }
35
- export interface TwitterPixelConfiguration extends UserDestinationConfiguration {
36
- twitterPixelId: string;
37
- }
38
- export interface IntercomTagConfiguration extends UserDestinationConfiguration {
39
- appId: string;
40
- apiBase: string;
41
- }
42
- export interface WebhookConfiguration extends UserDestinationConfiguration {
43
- webhookUrl: string;
44
- }
45
- export interface CustomHTMLConfiguration extends UserDestinationConfiguration {
46
- html: string;
47
- location: CustomHTMLLocation;
48
- }
49
- export declare enum CustomHTMLLocation {
50
- HEADER = "header",
51
- FOOTER = "footer",
52
- BODY = "body"
53
- }
1
+ import { Destination, UserDestinationConfiguration } from './destinations';
2
+ export interface AdTrackifyFacebookDestination extends Destination {
3
+ configuration: FacebookPixelConfiguration;
4
+ }
5
+ export interface AdTrackifyTikTokDestination extends Destination {
6
+ configuration: TiktokPixelConfiguration;
7
+ }
8
+ export interface AdTrackifyGoogleAnalytics4Destination extends Destination {
9
+ configuration: GoogleAnalytics4Configuration;
10
+ }
11
+ export interface FacebookPixelConfiguration extends UserDestinationConfiguration {
12
+ apiAccessToken?: string;
13
+ enableConversionAPI: boolean;
14
+ pixelId: string;
15
+ }
16
+ export interface TiktokPixelConfiguration extends UserDestinationConfiguration {
17
+ apiAccessToken?: string;
18
+ enableConversionAPI: boolean;
19
+ pixelId: string;
20
+ }
21
+ export interface GoogleAnalytics4Configuration extends UserDestinationConfiguration {
22
+ apiSecret: string;
23
+ measurementId: string;
24
+ }
25
+ export interface GoogleAdsConfiguration extends UserDestinationConfiguration {
26
+ pixelId: string;
27
+ conversionID: string;
28
+ }
29
+ export interface HubspotPixelConfiguration extends UserDestinationConfiguration {
30
+ hubspotId: string;
31
+ }
32
+ export interface SnapchatPixelConfiguration extends UserDestinationConfiguration {
33
+ snapchatPixelId: string;
34
+ }
35
+ export interface TwitterPixelConfiguration extends UserDestinationConfiguration {
36
+ twitterPixelId: string;
37
+ }
38
+ export interface IntercomTagConfiguration extends UserDestinationConfiguration {
39
+ appId: string;
40
+ apiBase: string;
41
+ }
42
+ export interface WebhookConfiguration extends UserDestinationConfiguration {
43
+ webhookUrl: string;
44
+ }
45
+ export interface CustomHTMLConfiguration extends UserDestinationConfiguration {
46
+ html: string;
47
+ location: CustomHTMLLocation;
48
+ }
49
+ export declare enum CustomHTMLLocation {
50
+ HEADER = "header",
51
+ FOOTER = "footer",
52
+ BODY = "body"
53
+ }
@@ -1,7 +1,7 @@
1
- export var CustomHTMLLocation;
2
- (function (CustomHTMLLocation) {
3
- CustomHTMLLocation["HEADER"] = "header";
4
- CustomHTMLLocation["FOOTER"] = "footer";
5
- CustomHTMLLocation["BODY"] = "body";
6
- })(CustomHTMLLocation || (CustomHTMLLocation = {}));
1
+ export var CustomHTMLLocation;
2
+ (function (CustomHTMLLocation) {
3
+ CustomHTMLLocation["HEADER"] = "header";
4
+ CustomHTMLLocation["FOOTER"] = "footer";
5
+ CustomHTMLLocation["BODY"] = "body";
6
+ })(CustomHTMLLocation || (CustomHTMLLocation = {}));
7
7
  //# sourceMappingURL=third-party-destination-configs.js.map
@@ -1,8 +1,8 @@
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';
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';
@@ -1,9 +1,9 @@
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';
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
9
  //# sourceMappingURL=index.js.map
@@ -1,143 +1,143 @@
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
- SHOPIFY_CUSTOMERS = "shopify.customers",
34
- SHOPIFY_ABANDONED_CHECKOUTS_VALUE = "shopify.abandoned_checkouts_value",
35
- SHOPIFY_ABANDONED_CHECKOUTS = "shopify.abandoned_checkouts",
36
- SHOPIFY_REFUNDS = "shopify.refunds_count",
37
- SHOPIFY_REFUND_REVENUE = "shopify.refunds_amount",
38
- SHOPIFY_REFUND_RATE = "shopify.refunds_rate",
39
- SHOPIFY_DISCOUNTS = "shopify.discounts_count",
40
- SHOPIFY_DISCOUNT_AMOUNT = "shopify.discount_amount",
41
- SHOPIFY_DISCOUNT_RATE = "shopify.discounts_rate",
42
- SHOPIFY_ORDERS = "shopify.order_count",
43
- SHOPIFY_REVENUE = "shopify.revenue",
44
- SHOPIFY_AOV = "shopify.average_order_value",
45
- SHOPIFY_TOP_PRODUCTS = "shopify.top_products",
46
- SHOPIFY_CUSTOMER_LTV = "shopify.customer_ltv",
47
- SHOPIFY_REPEAT_CUSTOMER_RATE = "shopify.repeat_customer_rate",
48
- SHOPIFY_TAX_AMOUNT = "shopify.tax_amount",
49
- SHOPIFY_SHIPPING_AMOUNT = "shopify.shipping_amount",
50
- SHOPIFY_SUBTOTAL_AMOUNT = "shopify.subtotal_amount",
51
- SHOPIFY_NEW_CUSTOMER_RATE = "shopify.new_customer_rate",
52
- SHOPIFY_RETURNING_CUSTOMER_RATE = "shopify.new_customer_rate",
53
- SITE_TTFB = "site.ttfb",
54
- SITE_FCP = "site.fcp",
55
- SITE_LCP = "site.lcp",
56
- SITE_TIME_ON_SITE = "site.time_on_site"
57
- }
58
- export interface Query {
59
- pixelId: string;
60
- measures: MEASURE[];
61
- dateRange: DateRange;
62
- compareDateRange?: DateRange;
63
- granularity?: GRANULARITY;
64
- dimensions?: DIMENSION[];
65
- filters?: any[];
66
- }
67
- export interface AppliedDimensions {
68
- dimensionName?: string;
69
- dimensionValue?: string;
70
- }
71
- export declare type MeasureDataRow = {
72
- [key: string]: any;
73
- dt?: string;
74
- start?: string;
75
- end?: string;
76
- };
77
- export interface QueryData {
78
- primary?: MeasureDataRow[];
79
- compare?: MeasureDataRow[];
80
- }
81
- export interface MeasureDetail {
82
- measure: MEASURE;
83
- isAverage: boolean;
84
- isPercentage: boolean;
85
- calculatedAverage: boolean;
86
- success: boolean;
87
- primaryAvg: number;
88
- compareAvg: number;
89
- primarySum: number;
90
- compareSum: number;
91
- percentDiff: number;
92
- }
93
- export interface QueryResult {
94
- granularity: GRANULARITY;
95
- dimensions: DIMENSION[];
96
- dateRange: DateRange;
97
- compareDateRange?: DateRange;
98
- measureDetails: MeasureDetail[] | null;
99
- data: QueryData | null;
100
- }
101
- export interface QueryResponse {
102
- results: QueryResult[];
103
- }
104
- export declare enum DIMENSION {
105
- DEVICE_MODEL = "device_model",
106
- DEVICE_VENDOR = "device_vendor",
107
- DEVICE_TYPE = "device_type",
108
- BROWSER = "browser",
109
- BROWSER_VERSION = "browser_version",
110
- BROWSER_OS = "browser_os",
111
- OS = "OS",
112
- LANDING_PATH = "landing_path",
113
- PAGE_PATH = "path",
114
- PAGE_TITLE = "title",
115
- QUERY_STRING = "query",
116
- GATEWAY = "gateway",
117
- CURRENCY = "currency",
118
- SHIPPING_CODE = "shipping_code",
119
- IS_MOBILE = "is_mobile",
120
- IS_WIRELESS = "is_wireless",
121
- CITY = "city",
122
- PROVINCE_CODE = "province_code",
123
- PROVINCE = "province",
124
- COUNTRY_CODE = "country_code",
125
- COUNTRY = "country",
126
- POSTAL_CODE = "postal_code",
127
- FINANCIAL_STATUS = "financial_status",
128
- FULFILLMENT_STATUS = "fulfillment_status",
129
- DISCOUNT_CODE = "discount_code",
130
- REFERRER = "referrer",
131
- REFERRER_MEDIUM = "referrer_medium",
132
- REFERRER_SOURCE = "referrer_source",
133
- REFERRER_TERM = "referrer_term",
134
- UTM_CAMPAIGN = "utm_campaign",
135
- UTM_SOURCE = "utm_source",
136
- UTM_MEDIUM = "utm_medium",
137
- UTM_TERM = "utm_term",
138
- UTM_CONTENT = "utm_content",
139
- CLICK_NETWORK = "click_network",
140
- ADBLOCK_DETECTED = "adblock_detected",
141
- TIMEZONE = "timezone",
142
- LOCALE = "locale"
143
- }
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
+ SHOPIFY_CUSTOMERS = "shopify.customers",
34
+ SHOPIFY_ABANDONED_CHECKOUTS_VALUE = "shopify.abandoned_checkouts_value",
35
+ SHOPIFY_ABANDONED_CHECKOUTS = "shopify.abandoned_checkouts",
36
+ SHOPIFY_REFUNDS = "shopify.refunds_count",
37
+ SHOPIFY_REFUND_REVENUE = "shopify.refunds_amount",
38
+ SHOPIFY_REFUND_RATE = "shopify.refunds_rate",
39
+ SHOPIFY_DISCOUNTS = "shopify.discounts_count",
40
+ SHOPIFY_DISCOUNT_AMOUNT = "shopify.discount_amount",
41
+ SHOPIFY_DISCOUNT_RATE = "shopify.discounts_rate",
42
+ SHOPIFY_ORDERS = "shopify.order_count",
43
+ SHOPIFY_REVENUE = "shopify.revenue",
44
+ SHOPIFY_AOV = "shopify.average_order_value",
45
+ SHOPIFY_TOP_PRODUCTS = "shopify.top_products",
46
+ SHOPIFY_CUSTOMER_LTV = "shopify.customer_ltv",
47
+ SHOPIFY_REPEAT_CUSTOMER_RATE = "shopify.repeat_customer_rate",
48
+ SHOPIFY_TAX_AMOUNT = "shopify.tax_amount",
49
+ SHOPIFY_SHIPPING_AMOUNT = "shopify.shipping_amount",
50
+ SHOPIFY_SUBTOTAL_AMOUNT = "shopify.subtotal_amount",
51
+ SHOPIFY_NEW_CUSTOMER_RATE = "shopify.new_customer_rate",
52
+ SHOPIFY_RETURNING_CUSTOMER_RATE = "shopify.new_customer_rate",
53
+ SITE_TTFB = "site.ttfb",
54
+ SITE_FCP = "site.fcp",
55
+ SITE_LCP = "site.lcp",
56
+ SITE_TIME_ON_SITE = "site.time_on_site"
57
+ }
58
+ export interface Query {
59
+ pixelId: string;
60
+ measures: MEASURE[];
61
+ dateRange: DateRange;
62
+ compareDateRange?: DateRange;
63
+ granularity?: GRANULARITY;
64
+ dimensions?: DIMENSION[];
65
+ filters?: any[];
66
+ }
67
+ export interface AppliedDimensions {
68
+ dimensionName?: string;
69
+ dimensionValue?: string;
70
+ }
71
+ export declare type MeasureDataRow = {
72
+ [key: string]: any;
73
+ dt?: string;
74
+ start?: string;
75
+ end?: string;
76
+ };
77
+ export interface QueryData {
78
+ primary?: MeasureDataRow[];
79
+ compare?: MeasureDataRow[];
80
+ }
81
+ export interface MeasureDetail {
82
+ measure: MEASURE;
83
+ isAverage: boolean;
84
+ isPercentage: boolean;
85
+ calculatedAverage: boolean;
86
+ success: boolean;
87
+ primaryAvg: number;
88
+ compareAvg: number;
89
+ primarySum: number;
90
+ compareSum: number;
91
+ percentDiff: number;
92
+ }
93
+ export interface QueryResult {
94
+ granularity: GRANULARITY;
95
+ dimensions: DIMENSION[];
96
+ dateRange: DateRange;
97
+ compareDateRange?: DateRange;
98
+ measureDetails: MeasureDetail[] | null;
99
+ data: QueryData | null;
100
+ }
101
+ export interface QueryResponse {
102
+ results: QueryResult[];
103
+ }
104
+ export declare enum DIMENSION {
105
+ DEVICE_MODEL = "device_model",
106
+ DEVICE_VENDOR = "device_vendor",
107
+ DEVICE_TYPE = "device_type",
108
+ BROWSER = "browser",
109
+ BROWSER_VERSION = "browser_version",
110
+ BROWSER_OS = "browser_os",
111
+ OS = "OS",
112
+ LANDING_PATH = "landing_path",
113
+ PAGE_PATH = "path",
114
+ PAGE_TITLE = "title",
115
+ QUERY_STRING = "query",
116
+ GATEWAY = "gateway",
117
+ CURRENCY = "currency",
118
+ SHIPPING_CODE = "shipping_code",
119
+ IS_MOBILE = "is_mobile",
120
+ IS_WIRELESS = "is_wireless",
121
+ CITY = "city",
122
+ PROVINCE_CODE = "province_code",
123
+ PROVINCE = "province",
124
+ COUNTRY_CODE = "country_code",
125
+ COUNTRY = "country",
126
+ POSTAL_CODE = "postal_code",
127
+ FINANCIAL_STATUS = "financial_status",
128
+ FULFILLMENT_STATUS = "fulfillment_status",
129
+ DISCOUNT_CODE = "discount_code",
130
+ REFERRER = "referrer",
131
+ REFERRER_MEDIUM = "referrer_medium",
132
+ REFERRER_SOURCE = "referrer_source",
133
+ REFERRER_TERM = "referrer_term",
134
+ UTM_CAMPAIGN = "utm_campaign",
135
+ UTM_SOURCE = "utm_source",
136
+ UTM_MEDIUM = "utm_medium",
137
+ UTM_TERM = "utm_term",
138
+ UTM_CONTENT = "utm_content",
139
+ CLICK_NETWORK = "click_network",
140
+ ADBLOCK_DETECTED = "adblock_detected",
141
+ TIMEZONE = "timezone",
142
+ LOCALE = "locale"
143
+ }
@@ -1,97 +1,97 @@
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["SHOPIFY_CUSTOMERS"] = "shopify.customers";
32
- MEASURE["SHOPIFY_ABANDONED_CHECKOUTS_VALUE"] = "shopify.abandoned_checkouts_value";
33
- MEASURE["SHOPIFY_ABANDONED_CHECKOUTS"] = "shopify.abandoned_checkouts";
34
- MEASURE["SHOPIFY_REFUNDS"] = "shopify.refunds_count";
35
- MEASURE["SHOPIFY_REFUND_REVENUE"] = "shopify.refunds_amount";
36
- MEASURE["SHOPIFY_REFUND_RATE"] = "shopify.refunds_rate";
37
- MEASURE["SHOPIFY_DISCOUNTS"] = "shopify.discounts_count";
38
- MEASURE["SHOPIFY_DISCOUNT_AMOUNT"] = "shopify.discount_amount";
39
- MEASURE["SHOPIFY_DISCOUNT_RATE"] = "shopify.discounts_rate";
40
- MEASURE["SHOPIFY_ORDERS"] = "shopify.order_count";
41
- MEASURE["SHOPIFY_REVENUE"] = "shopify.revenue";
42
- MEASURE["SHOPIFY_AOV"] = "shopify.average_order_value";
43
- MEASURE["SHOPIFY_TOP_PRODUCTS"] = "shopify.top_products";
44
- MEASURE["SHOPIFY_CUSTOMER_LTV"] = "shopify.customer_ltv";
45
- MEASURE["SHOPIFY_REPEAT_CUSTOMER_RATE"] = "shopify.repeat_customer_rate";
46
- MEASURE["SHOPIFY_TAX_AMOUNT"] = "shopify.tax_amount";
47
- MEASURE["SHOPIFY_SHIPPING_AMOUNT"] = "shopify.shipping_amount";
48
- MEASURE["SHOPIFY_SUBTOTAL_AMOUNT"] = "shopify.subtotal_amount";
49
- MEASURE["SHOPIFY_NEW_CUSTOMER_RATE"] = "shopify.new_customer_rate";
50
- MEASURE["SHOPIFY_RETURNING_CUSTOMER_RATE"] = "shopify.new_customer_rate";
51
- MEASURE["SITE_TTFB"] = "site.ttfb";
52
- MEASURE["SITE_FCP"] = "site.fcp";
53
- MEASURE["SITE_LCP"] = "site.lcp";
54
- MEASURE["SITE_TIME_ON_SITE"] = "site.time_on_site";
55
- })(MEASURE || (MEASURE = {}));
56
- export var DIMENSION;
57
- (function (DIMENSION) {
58
- DIMENSION["DEVICE_MODEL"] = "device_model";
59
- DIMENSION["DEVICE_VENDOR"] = "device_vendor";
60
- DIMENSION["DEVICE_TYPE"] = "device_type";
61
- DIMENSION["BROWSER"] = "browser";
62
- DIMENSION["BROWSER_VERSION"] = "browser_version";
63
- DIMENSION["BROWSER_OS"] = "browser_os";
64
- DIMENSION["OS"] = "OS";
65
- DIMENSION["LANDING_PATH"] = "landing_path";
66
- DIMENSION["PAGE_PATH"] = "path";
67
- DIMENSION["PAGE_TITLE"] = "title";
68
- DIMENSION["QUERY_STRING"] = "query";
69
- DIMENSION["GATEWAY"] = "gateway";
70
- DIMENSION["CURRENCY"] = "currency";
71
- DIMENSION["SHIPPING_CODE"] = "shipping_code";
72
- DIMENSION["IS_MOBILE"] = "is_mobile";
73
- DIMENSION["IS_WIRELESS"] = "is_wireless";
74
- DIMENSION["CITY"] = "city";
75
- DIMENSION["PROVINCE_CODE"] = "province_code";
76
- DIMENSION["PROVINCE"] = "province";
77
- DIMENSION["COUNTRY_CODE"] = "country_code";
78
- DIMENSION["COUNTRY"] = "country";
79
- DIMENSION["POSTAL_CODE"] = "postal_code";
80
- DIMENSION["FINANCIAL_STATUS"] = "financial_status";
81
- DIMENSION["FULFILLMENT_STATUS"] = "fulfillment_status";
82
- DIMENSION["DISCOUNT_CODE"] = "discount_code";
83
- DIMENSION["REFERRER"] = "referrer";
84
- DIMENSION["REFERRER_MEDIUM"] = "referrer_medium";
85
- DIMENSION["REFERRER_SOURCE"] = "referrer_source";
86
- DIMENSION["REFERRER_TERM"] = "referrer_term";
87
- DIMENSION["UTM_CAMPAIGN"] = "utm_campaign";
88
- DIMENSION["UTM_SOURCE"] = "utm_source";
89
- DIMENSION["UTM_MEDIUM"] = "utm_medium";
90
- DIMENSION["UTM_TERM"] = "utm_term";
91
- DIMENSION["UTM_CONTENT"] = "utm_content";
92
- DIMENSION["CLICK_NETWORK"] = "click_network";
93
- DIMENSION["ADBLOCK_DETECTED"] = "adblock_detected";
94
- DIMENSION["TIMEZONE"] = "timezone";
95
- DIMENSION["LOCALE"] = "locale";
96
- })(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["SHOPIFY_CUSTOMERS"] = "shopify.customers";
32
+ MEASURE["SHOPIFY_ABANDONED_CHECKOUTS_VALUE"] = "shopify.abandoned_checkouts_value";
33
+ MEASURE["SHOPIFY_ABANDONED_CHECKOUTS"] = "shopify.abandoned_checkouts";
34
+ MEASURE["SHOPIFY_REFUNDS"] = "shopify.refunds_count";
35
+ MEASURE["SHOPIFY_REFUND_REVENUE"] = "shopify.refunds_amount";
36
+ MEASURE["SHOPIFY_REFUND_RATE"] = "shopify.refunds_rate";
37
+ MEASURE["SHOPIFY_DISCOUNTS"] = "shopify.discounts_count";
38
+ MEASURE["SHOPIFY_DISCOUNT_AMOUNT"] = "shopify.discount_amount";
39
+ MEASURE["SHOPIFY_DISCOUNT_RATE"] = "shopify.discounts_rate";
40
+ MEASURE["SHOPIFY_ORDERS"] = "shopify.order_count";
41
+ MEASURE["SHOPIFY_REVENUE"] = "shopify.revenue";
42
+ MEASURE["SHOPIFY_AOV"] = "shopify.average_order_value";
43
+ MEASURE["SHOPIFY_TOP_PRODUCTS"] = "shopify.top_products";
44
+ MEASURE["SHOPIFY_CUSTOMER_LTV"] = "shopify.customer_ltv";
45
+ MEASURE["SHOPIFY_REPEAT_CUSTOMER_RATE"] = "shopify.repeat_customer_rate";
46
+ MEASURE["SHOPIFY_TAX_AMOUNT"] = "shopify.tax_amount";
47
+ MEASURE["SHOPIFY_SHIPPING_AMOUNT"] = "shopify.shipping_amount";
48
+ MEASURE["SHOPIFY_SUBTOTAL_AMOUNT"] = "shopify.subtotal_amount";
49
+ MEASURE["SHOPIFY_NEW_CUSTOMER_RATE"] = "shopify.new_customer_rate";
50
+ MEASURE["SHOPIFY_RETURNING_CUSTOMER_RATE"] = "shopify.new_customer_rate";
51
+ MEASURE["SITE_TTFB"] = "site.ttfb";
52
+ MEASURE["SITE_FCP"] = "site.fcp";
53
+ MEASURE["SITE_LCP"] = "site.lcp";
54
+ MEASURE["SITE_TIME_ON_SITE"] = "site.time_on_site";
55
+ })(MEASURE || (MEASURE = {}));
56
+ export var DIMENSION;
57
+ (function (DIMENSION) {
58
+ DIMENSION["DEVICE_MODEL"] = "device_model";
59
+ DIMENSION["DEVICE_VENDOR"] = "device_vendor";
60
+ DIMENSION["DEVICE_TYPE"] = "device_type";
61
+ DIMENSION["BROWSER"] = "browser";
62
+ DIMENSION["BROWSER_VERSION"] = "browser_version";
63
+ DIMENSION["BROWSER_OS"] = "browser_os";
64
+ DIMENSION["OS"] = "OS";
65
+ DIMENSION["LANDING_PATH"] = "landing_path";
66
+ DIMENSION["PAGE_PATH"] = "path";
67
+ DIMENSION["PAGE_TITLE"] = "title";
68
+ DIMENSION["QUERY_STRING"] = "query";
69
+ DIMENSION["GATEWAY"] = "gateway";
70
+ DIMENSION["CURRENCY"] = "currency";
71
+ DIMENSION["SHIPPING_CODE"] = "shipping_code";
72
+ DIMENSION["IS_MOBILE"] = "is_mobile";
73
+ DIMENSION["IS_WIRELESS"] = "is_wireless";
74
+ DIMENSION["CITY"] = "city";
75
+ DIMENSION["PROVINCE_CODE"] = "province_code";
76
+ DIMENSION["PROVINCE"] = "province";
77
+ DIMENSION["COUNTRY_CODE"] = "country_code";
78
+ DIMENSION["COUNTRY"] = "country";
79
+ DIMENSION["POSTAL_CODE"] = "postal_code";
80
+ DIMENSION["FINANCIAL_STATUS"] = "financial_status";
81
+ DIMENSION["FULFILLMENT_STATUS"] = "fulfillment_status";
82
+ DIMENSION["DISCOUNT_CODE"] = "discount_code";
83
+ DIMENSION["REFERRER"] = "referrer";
84
+ DIMENSION["REFERRER_MEDIUM"] = "referrer_medium";
85
+ DIMENSION["REFERRER_SOURCE"] = "referrer_source";
86
+ DIMENSION["REFERRER_TERM"] = "referrer_term";
87
+ DIMENSION["UTM_CAMPAIGN"] = "utm_campaign";
88
+ DIMENSION["UTM_SOURCE"] = "utm_source";
89
+ DIMENSION["UTM_MEDIUM"] = "utm_medium";
90
+ DIMENSION["UTM_TERM"] = "utm_term";
91
+ DIMENSION["UTM_CONTENT"] = "utm_content";
92
+ DIMENSION["CLICK_NETWORK"] = "click_network";
93
+ DIMENSION["ADBLOCK_DETECTED"] = "adblock_detected";
94
+ DIMENSION["TIMEZONE"] = "timezone";
95
+ DIMENSION["LOCALE"] = "locale";
96
+ })(DIMENSION || (DIMENSION = {}));
97
97
  //# sourceMappingURL=query.js.map