|
17 | 17 | "format": "date-time"
|
18 | 18 | },
|
19 | 19 | "customer_journey_summary": {
|
20 |
| - "ready": { |
21 |
| - "description": "Whether the attributed sessions for the order have been created yet.", |
22 |
| - "type": ["null", "boolean"] |
23 |
| - }, |
24 |
| - "moments_count": { |
25 |
| - "description": "The total number of customer moments associated with this order. Returns null if the order is still in the process of being attributed.", |
26 |
| - "type": ["null", "object"], |
27 |
| - "properties": { |
28 |
| - "count": { |
29 |
| - "description": "Count of elements.", |
30 |
| - "type": ["null", "integer"] |
31 |
| - }, |
32 |
| - "precision": { |
33 |
| - "description": "Precision of count, how exact is the value.", |
34 |
| - "type": ["null", "string"] |
| 20 | + "description": "Represents a customer's visiting activities on a shop's online store.", |
| 21 | + "type": ["null", "object"], |
| 22 | + "properties": { |
| 23 | + "ready": { |
| 24 | + "description": "Whether the attributed sessions for the order have been created yet.", |
| 25 | + "type": ["null", "boolean"] |
| 26 | + }, |
| 27 | + "moments_count": { |
| 28 | + "description": "The total number of customer moments associated with this order. Returns null if the order is still in the process of being attributed.", |
| 29 | + "type": ["null", "object"], |
| 30 | + "properties": { |
| 31 | + "count": { |
| 32 | + "description": "Count of elements.", |
| 33 | + "type": ["null", "integer"] |
| 34 | + }, |
| 35 | + "precision": { |
| 36 | + "description": "Precision of count, how exact is the value.", |
| 37 | + "type": ["null", "string"] |
| 38 | + } |
35 | 39 | }
|
36 |
| - } |
37 |
| - }, |
38 |
| - "customer_order_index": { |
39 |
| - "description": "The position of the current order within the customer's order history. Test orders aren't included.", |
40 |
| - "type": ["null", "integer"] |
41 |
| - }, |
42 |
| - "days_to_conversion": { |
43 |
| - "description": "The number of days between the first session and the order creation date. The first session represents the first session since the last order, or the first session within the 30 day attribution window, if more than 30 days have passed since the last order.", |
44 |
| - "type": ["null", "integer"] |
45 |
| - }, |
46 |
| - "first_visit": { |
47 |
| - "description": "The customer's first session going into the shop.", |
48 |
| - "type": ["null", "object"], |
49 |
| - "properties": { |
50 |
| - "id": { |
51 |
| - "description": "A globally-unique ID.", |
52 |
| - "type": ["null", "integer"] |
53 |
| - }, |
54 |
| - "landing_page": { |
55 |
| - "description": "URL of the first page the customer landed on for the session.", |
56 |
| - "type": ["null", "string"] |
57 |
| - }, |
58 |
| - "landing_page_html": { |
59 |
| - "description": "Landing page information with URL linked in HTML. For example, the first page the customer visited was", |
60 |
| - "type": ["null", "string"] |
61 |
| - }, |
62 |
| - "occurred_at": { |
63 |
| - "description": "The date and time when the customer's session occurred.", |
64 |
| - "type": ["null", "string"], |
65 |
| - "format": "date-time" |
66 |
| - }, |
67 |
| - "referral_code": { |
68 |
| - "description": "Marketing referral code from the link that the customer clicked to visit the store.", |
69 |
| - "type": ["null", "string"] |
70 |
| - }, |
71 |
| - "referrer_url": { |
72 |
| - "description": "Webpage where the customer clicked a link that sent them to the online store.", |
73 |
| - "type": ["null", "string"] |
74 |
| - }, |
75 |
| - "source": { |
76 |
| - "description": "Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown.", |
77 |
| - "type": ["null", "string"] |
78 |
| - }, |
79 |
| - "source_type": { |
80 |
| - "description": "Type of marketing tactic.", |
81 |
| - "type": ["null", "string"] |
82 |
| - }, |
83 |
| - "source_description": { |
84 |
| - "description": "Describes the source explicitly for first or last session.", |
85 |
| - "type": ["null", "string"] |
86 |
| - }, |
87 |
| - "utm_parameters": { |
88 |
| - "description": "A set of UTM parameters gathered from the URL parameters of the referrer.", |
89 |
| - "type": ["null", "object"], |
90 |
| - "properties": { |
91 |
| - "campaign": { |
92 |
| - "description": "The name of a marketing campaign.", |
93 |
| - "type": ["null", "string"] |
94 |
| - }, |
95 |
| - "content": { |
96 |
| - "description": "Identifies specific content in a marketing campaign. Used to differentiate between similar content or links in a marketing campaign to determine which is the most effective.", |
97 |
| - "type": ["null", "string"] |
98 |
| - }, |
99 |
| - "medium": { |
100 |
| - "description": "The medium of a marketing campaign, such as a banner or email newsletter.", |
101 |
| - "type": ["null", "string"] |
102 |
| - }, |
103 |
| - "source": { |
104 |
| - "description": "The source of traffic to the merchant's store, such as Google or an email newsletter.", |
105 |
| - "type": ["null", "string"] |
106 |
| - }, |
107 |
| - "term": { |
108 |
| - "description": "Paid search terms used by a marketing campaign.", |
109 |
| - "type": ["null", "string"] |
| 40 | + }, |
| 41 | + "customer_order_index": { |
| 42 | + "description": "The position of the current order within the customer's order history. Test orders aren't included.", |
| 43 | + "type": ["null", "integer"] |
| 44 | + }, |
| 45 | + "days_to_conversion": { |
| 46 | + "description": "The number of days between the first session and the order creation date. The first session represents the first session since the last order, or the first session within the 30 day attribution window, if more than 30 days have passed since the last order.", |
| 47 | + "type": ["null", "integer"] |
| 48 | + }, |
| 49 | + "first_visit": { |
| 50 | + "description": "The customer's first session going into the shop.", |
| 51 | + "type": ["null", "object"], |
| 52 | + "properties": { |
| 53 | + "id": { |
| 54 | + "description": "A globally-unique ID.", |
| 55 | + "type": ["null", "integer"] |
| 56 | + }, |
| 57 | + "landing_page": { |
| 58 | + "description": "URL of the first page the customer landed on for the session.", |
| 59 | + "type": ["null", "string"] |
| 60 | + }, |
| 61 | + "landing_page_html": { |
| 62 | + "description": "Landing page information with URL linked in HTML. For example, the first page the customer visited was", |
| 63 | + "type": ["null", "string"] |
| 64 | + }, |
| 65 | + "occurred_at": { |
| 66 | + "description": "The date and time when the customer's session occurred.", |
| 67 | + "type": ["null", "string"], |
| 68 | + "format": "date-time" |
| 69 | + }, |
| 70 | + "referral_code": { |
| 71 | + "description": "Marketing referral code from the link that the customer clicked to visit the store.", |
| 72 | + "type": ["null", "string"] |
| 73 | + }, |
| 74 | + "referrer_url": { |
| 75 | + "description": "Webpage where the customer clicked a link that sent them to the online store.", |
| 76 | + "type": ["null", "string"] |
| 77 | + }, |
| 78 | + "source": { |
| 79 | + "description": "Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown.", |
| 80 | + "type": ["null", "string"] |
| 81 | + }, |
| 82 | + "source_type": { |
| 83 | + "description": "Type of marketing tactic.", |
| 84 | + "type": ["null", "string"] |
| 85 | + }, |
| 86 | + "source_description": { |
| 87 | + "description": "Describes the source explicitly for first or last session.", |
| 88 | + "type": ["null", "string"] |
| 89 | + }, |
| 90 | + "utm_parameters": { |
| 91 | + "description": "A set of UTM parameters gathered from the URL parameters of the referrer.", |
| 92 | + "type": ["null", "object"], |
| 93 | + "properties": { |
| 94 | + "campaign": { |
| 95 | + "description": "The name of a marketing campaign.", |
| 96 | + "type": ["null", "string"] |
| 97 | + }, |
| 98 | + "content": { |
| 99 | + "description": "Identifies specific content in a marketing campaign. Used to differentiate between similar content or links in a marketing campaign to determine which is the most effective.", |
| 100 | + "type": ["null", "string"] |
| 101 | + }, |
| 102 | + "medium": { |
| 103 | + "description": "The medium of a marketing campaign, such as a banner or email newsletter.", |
| 104 | + "type": ["null", "string"] |
| 105 | + }, |
| 106 | + "source": { |
| 107 | + "description": "The source of traffic to the merchant's store, such as Google or an email newsletter.", |
| 108 | + "type": ["null", "string"] |
| 109 | + }, |
| 110 | + "term": { |
| 111 | + "description": "Paid search terms used by a marketing campaign.", |
| 112 | + "type": ["null", "string"] |
| 113 | + } |
110 | 114 | }
|
| 115 | + }, |
| 116 | + "admin_graphql_api_id": { |
| 117 | + "description": "Unique identifier for the customer in the Admin GraphQL API.", |
| 118 | + "type": ["null", "string"] |
111 | 119 | }
|
112 |
| - }, |
113 |
| - "admin_graphql_api_id": { |
114 |
| - "description": "Unique identifier for the customer in the Admin GraphQL API.", |
115 |
| - "type": ["null", "string"] |
116 | 120 | }
|
117 |
| - } |
118 |
| - }, |
119 |
| - "last_visit": { |
120 |
| - "description": "The last session before an order is made.", |
121 |
| - "type": ["null", "object"], |
122 |
| - "properties": { |
123 |
| - "id": { |
124 |
| - "description": "A globally-unique ID.", |
125 |
| - "type": ["null", "integer"] |
126 |
| - }, |
127 |
| - "landing_page": { |
128 |
| - "description": "URL of the first page the customer landed on for the session.", |
129 |
| - "type": ["null", "string"] |
130 |
| - }, |
131 |
| - "landing_page_html": { |
132 |
| - "description": "Landing page information with URL linked in HTML. For example, the first page the customer visited was", |
133 |
| - "type": ["null", "string"] |
134 |
| - }, |
135 |
| - "occurred_at": { |
136 |
| - "description": "The date and time when the customer's session occurred.", |
137 |
| - "type": ["null", "string"], |
138 |
| - "format": "date-time" |
139 |
| - }, |
140 |
| - "referral_code": { |
141 |
| - "description": "Marketing referral code from the link that the customer clicked to visit the store.", |
142 |
| - "type": ["null", "string"] |
143 |
| - }, |
144 |
| - "referrer_url": { |
145 |
| - "description": "Webpage where the customer clicked a link that sent them to the online store.", |
146 |
| - "type": ["null", "string"] |
147 |
| - }, |
148 |
| - "source": { |
149 |
| - "description": "Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown.", |
150 |
| - "type": ["null", "string"] |
151 |
| - }, |
152 |
| - "source_type": { |
153 |
| - "description": "Type of marketing tactic.", |
154 |
| - "type": ["null", "string"] |
155 |
| - }, |
156 |
| - "source_description": { |
157 |
| - "description": "Describes the source explicitly for first or last session.", |
158 |
| - "type": ["null", "string"] |
159 |
| - }, |
160 |
| - "utm_parameters": { |
161 |
| - "description": "A set of UTM parameters gathered from the URL parameters of the referrer.", |
162 |
| - "type": ["null", "object"], |
163 |
| - "properties": { |
164 |
| - "campaign": { |
165 |
| - "description": "The name of a marketing campaign.", |
166 |
| - "type": ["null", "string"] |
167 |
| - }, |
168 |
| - "content": { |
169 |
| - "description": "Identifies specific content in a marketing campaign. Used to differentiate between similar content or links in a marketing campaign to determine which is the most effective.", |
170 |
| - "type": ["null", "string"] |
171 |
| - }, |
172 |
| - "medium": { |
173 |
| - "description": "The medium of a marketing campaign, such as a banner or email newsletter.", |
174 |
| - "type": ["null", "string"] |
175 |
| - }, |
176 |
| - "source": { |
177 |
| - "description": "The source of traffic to the merchant's store, such as Google or an email newsletter.", |
178 |
| - "type": ["null", "string"] |
179 |
| - }, |
180 |
| - "term": { |
181 |
| - "description": "Paid search terms used by a marketing campaign.", |
182 |
| - "type": ["null", "string"] |
| 121 | + }, |
| 122 | + "last_visit": { |
| 123 | + "description": "The last session before an order is made.", |
| 124 | + "type": ["null", "object"], |
| 125 | + "properties": { |
| 126 | + "id": { |
| 127 | + "description": "A globally-unique ID.", |
| 128 | + "type": ["null", "integer"] |
| 129 | + }, |
| 130 | + "landing_page": { |
| 131 | + "description": "URL of the first page the customer landed on for the session.", |
| 132 | + "type": ["null", "string"] |
| 133 | + }, |
| 134 | + "landing_page_html": { |
| 135 | + "description": "Landing page information with URL linked in HTML. For example, the first page the customer visited was", |
| 136 | + "type": ["null", "string"] |
| 137 | + }, |
| 138 | + "occurred_at": { |
| 139 | + "description": "The date and time when the customer's session occurred.", |
| 140 | + "type": ["null", "string"], |
| 141 | + "format": "date-time" |
| 142 | + }, |
| 143 | + "referral_code": { |
| 144 | + "description": "Marketing referral code from the link that the customer clicked to visit the store.", |
| 145 | + "type": ["null", "string"] |
| 146 | + }, |
| 147 | + "referrer_url": { |
| 148 | + "description": "Webpage where the customer clicked a link that sent them to the online store.", |
| 149 | + "type": ["null", "string"] |
| 150 | + }, |
| 151 | + "source": { |
| 152 | + "description": "Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown.", |
| 153 | + "type": ["null", "string"] |
| 154 | + }, |
| 155 | + "source_type": { |
| 156 | + "description": "Type of marketing tactic.", |
| 157 | + "type": ["null", "string"] |
| 158 | + }, |
| 159 | + "source_description": { |
| 160 | + "description": "Describes the source explicitly for first or last session.", |
| 161 | + "type": ["null", "string"] |
| 162 | + }, |
| 163 | + "utm_parameters": { |
| 164 | + "description": "A set of UTM parameters gathered from the URL parameters of the referrer.", |
| 165 | + "type": ["null", "object"], |
| 166 | + "properties": { |
| 167 | + "campaign": { |
| 168 | + "description": "The name of a marketing campaign.", |
| 169 | + "type": ["null", "string"] |
| 170 | + }, |
| 171 | + "content": { |
| 172 | + "description": "Identifies specific content in a marketing campaign. Used to differentiate between similar content or links in a marketing campaign to determine which is the most effective.", |
| 173 | + "type": ["null", "string"] |
| 174 | + }, |
| 175 | + "medium": { |
| 176 | + "description": "The medium of a marketing campaign, such as a banner or email newsletter.", |
| 177 | + "type": ["null", "string"] |
| 178 | + }, |
| 179 | + "source": { |
| 180 | + "description": "The source of traffic to the merchant's store, such as Google or an email newsletter.", |
| 181 | + "type": ["null", "string"] |
| 182 | + }, |
| 183 | + "term": { |
| 184 | + "description": "Paid search terms used by a marketing campaign.", |
| 185 | + "type": ["null", "string"] |
| 186 | + } |
183 | 187 | }
|
| 188 | + }, |
| 189 | + "admin_graphql_api_id": { |
| 190 | + "description": "Unique identifier for the customer in the Admin GraphQL API.", |
| 191 | + "type": ["null", "string"] |
184 | 192 | }
|
185 |
| - }, |
186 |
| - "admin_graphql_api_id": { |
187 |
| - "description": "Unique identifier for the customer in the Admin GraphQL API.", |
188 |
| - "type": ["null", "string"] |
189 | 193 | }
|
190 | 194 | }
|
191 | 195 | }
|
|
0 commit comments