|
5 | 5 | "additionalProperties": true,
|
6 | 6 | "properties": {
|
7 | 7 | "id": {
|
| 8 | + "description": "The unique identifier for the automation", |
8 | 9 | "type": ["null", "string"]
|
9 | 10 | },
|
10 | 11 | "create_time": {
|
| 12 | + "description": "The timestamp when the automation was created", |
11 | 13 | "type": ["null", "string"],
|
12 | 14 | "format": "date-time",
|
13 | 15 | "airbyte-type": "timestamp_with_timezone"
|
14 | 16 | },
|
15 | 17 | "start_time": {
|
| 18 | + "description": "The timestamp when the automation started", |
16 | 19 | "type": ["null", "string"],
|
17 | 20 | "format": "date-time",
|
18 | 21 | "airbyte_type": "timestamp_with_timezone"
|
19 | 22 | },
|
20 | 23 | "status": {
|
| 24 | + "description": "Current status of the automation", |
21 | 25 | "type": ["null", "string"]
|
22 | 26 | },
|
23 | 27 | "emails_sent": {
|
| 28 | + "description": "The number of emails sent as part of the automation", |
24 | 29 | "type": ["null", "number"]
|
25 | 30 | },
|
26 | 31 | "recipients": {
|
| 32 | + "description": "Details about the recipients of the automation", |
27 | 33 | "type": ["null", "object"],
|
28 | 34 | "properties": {
|
29 | 35 | "list_id": {
|
| 36 | + "description": "The ID of the recipient list", |
30 | 37 | "type": ["null", "string"]
|
31 | 38 | },
|
32 | 39 | "list_is_active": {
|
| 40 | + "description": "Indicates if the recipient list is active", |
33 | 41 | "type": ["null", "boolean"]
|
34 | 42 | },
|
35 | 43 | "list_name": {
|
| 44 | + "description": "The name of the recipient list", |
36 | 45 | "type": ["null", "string"]
|
37 | 46 | },
|
38 | 47 | "segment_opts": {
|
| 48 | + "description": "Options related to segmenting recipients", |
39 | 49 | "type": ["null", "object"],
|
40 | 50 | "properties": {
|
41 | 51 | "saved_segment_id": {
|
| 52 | + "description": "The ID of the saved segment", |
42 | 53 | "type": ["null", "number"]
|
43 | 54 | },
|
44 | 55 | "match": {
|
| 56 | + "description": "Matching criteria for segmenting recipients", |
45 | 57 | "type": ["null", "string"]
|
46 | 58 | },
|
47 | 59 | "conditions": {
|
| 60 | + "description": "Conditions for segmenting recipients", |
48 | 61 | "type": ["null", "array"],
|
49 | 62 | "items": {
|
50 | 63 | "type": ["null", "object"],
|
|
54 | 67 | }
|
55 | 68 | },
|
56 | 69 | "store_id": {
|
| 70 | + "description": "The ID of the store associated with recipients", |
57 | 71 | "type": ["null", "string"]
|
58 | 72 | }
|
59 | 73 | }
|
60 | 74 | },
|
61 | 75 | "settings": {
|
| 76 | + "description": "Settings related to the automation", |
62 | 77 | "type": ["null", "object"],
|
63 | 78 | "properties": {
|
64 | 79 | "title": {
|
| 80 | + "description": "Title of the automation", |
65 | 81 | "type": ["null", "string"]
|
66 | 82 | },
|
67 | 83 | "from_name": {
|
| 84 | + "description": "Sender's name", |
68 | 85 | "type": ["null", "string"]
|
69 | 86 | },
|
70 | 87 | "reply_to": {
|
| 88 | + "description": "Email address for replies", |
71 | 89 | "type": ["null", "string"]
|
72 | 90 | },
|
73 | 91 | "use_conversation": {
|
| 92 | + "description": "Enable conversation tracking", |
74 | 93 | "type": ["null", "boolean"]
|
75 | 94 | },
|
76 | 95 | "to_name": {
|
| 96 | + "description": "Recipient's name field", |
77 | 97 | "type": ["null", "string"]
|
78 | 98 | },
|
79 | 99 | "authenticate": {
|
| 100 | + "description": "Indicates if authentication is set", |
80 | 101 | "type": ["null", "boolean"]
|
81 | 102 | },
|
82 | 103 | "auto_footer": {
|
| 104 | + "description": "Automatically add footer to emails", |
83 | 105 | "type": ["null", "boolean"]
|
84 | 106 | },
|
85 | 107 | "inline_css": {
|
| 108 | + "description": "Include inline CSS in emails", |
86 | 109 | "type": ["null", "boolean"]
|
87 | 110 | }
|
88 | 111 | }
|
89 | 112 | },
|
90 | 113 | "tracking": {
|
| 114 | + "description": "Tracking settings for the automation", |
91 | 115 | "type": ["null", "object"],
|
92 | 116 | "properties": {
|
93 | 117 | "opens": {
|
| 118 | + "description": "Open tracking status", |
94 | 119 | "type": ["null", "boolean"]
|
95 | 120 | },
|
96 | 121 | "html_clicks": {
|
| 122 | + "description": "HTML click tracking status", |
97 | 123 | "type": ["null", "boolean"]
|
98 | 124 | },
|
99 | 125 | "text_clicks": {
|
| 126 | + "description": "Text click tracking status", |
100 | 127 | "type": ["null", "boolean"]
|
101 | 128 | },
|
102 | 129 | "goal_tracking": {
|
| 130 | + "description": "Goal tracking setup status", |
103 | 131 | "type": ["null", "boolean"]
|
104 | 132 | },
|
105 | 133 | "ecomm360": {
|
| 134 | + "description": "Ecommerce tracking status", |
106 | 135 | "type": ["null", "boolean"]
|
107 | 136 | },
|
108 | 137 | "google_analytics": {
|
| 138 | + "description": "Google Analytics tracking status", |
109 | 139 | "type": ["null", "string"]
|
110 | 140 | },
|
111 | 141 | "clicktale": {
|
| 142 | + "description": "Clicktale tracking status", |
112 | 143 | "type": ["null", "string"]
|
113 | 144 | },
|
114 | 145 | "salesforce": {
|
| 146 | + "description": "Salesforce tracking details", |
115 | 147 | "type": ["null", "object"],
|
116 | 148 | "properties": {
|
117 | 149 | "campaign": {
|
| 150 | + "description": "Salesforce campaign tracking status", |
118 | 151 | "type": ["null", "boolean"]
|
119 | 152 | },
|
120 | 153 | "notes": {
|
| 154 | + "description": "Additional notes for Salesforce tracking", |
121 | 155 | "type": ["null", "boolean"]
|
122 | 156 | }
|
123 | 157 | }
|
124 | 158 | },
|
125 | 159 | "capsule": {
|
| 160 | + "description": "Notes related to capsule tracking", |
126 | 161 | "type": ["null", "object"],
|
127 | 162 | "properties": {
|
128 | 163 | "notes": {
|
| 164 | + "description": "Additional notes for capsule tracking", |
129 | 165 | "type": ["null", "boolean"]
|
130 | 166 | }
|
131 | 167 | }
|
132 | 168 | }
|
133 | 169 | }
|
134 | 170 | },
|
135 | 171 | "trigger_settings": {
|
| 172 | + "description": "Settings related to the triggers of the automation", |
136 | 173 | "type": ["null", "object"],
|
137 | 174 | "properties": {
|
138 | 175 | "workflow_type": {
|
| 176 | + "description": "Type of workflow", |
139 | 177 | "type": ["null", "string"]
|
140 | 178 | },
|
141 | 179 | "workflow_title": {
|
| 180 | + "description": "Title of the workflow", |
142 | 181 | "type": ["null", "string"]
|
143 | 182 | },
|
144 | 183 | "runtime": {
|
| 184 | + "description": "Runtime settings for the automation", |
145 | 185 | "type": ["null", "object"],
|
146 | 186 | "properties": {
|
147 | 187 | "days": {
|
| 188 | + "description": "Days of the week for triggering the automation", |
148 | 189 | "type": ["null", "array"],
|
149 | 190 | "items": {
|
150 | 191 | "type": ["null", "string"]
|
151 | 192 | }
|
152 | 193 | },
|
153 | 194 | "hours": {
|
| 195 | + "description": "Hourly trigger settings", |
154 | 196 | "type": ["null", "object"],
|
155 | 197 | "properties": {
|
156 | 198 | "type": {
|
| 199 | + "description": "Type of hourly triggering", |
157 | 200 | "type": ["null", "string"]
|
158 | 201 | }
|
159 | 202 | }
|
160 | 203 | }
|
161 | 204 | }
|
162 | 205 | },
|
163 | 206 | "workflow_emails_count": {
|
| 207 | + "description": "Number of emails in the workflow", |
164 | 208 | "type": ["null", "number"]
|
165 | 209 | }
|
166 | 210 | }
|
167 | 211 | },
|
168 | 212 | "report_summary": {
|
| 213 | + "description": "Summary of the report generated for the automation", |
169 | 214 | "type": ["null", "object"],
|
170 | 215 | "properties": {
|
171 | 216 | "opens": {
|
| 217 | + "description": "The total number of opens generated", |
172 | 218 | "type": ["null", "number"]
|
173 | 219 | },
|
174 | 220 | "unique_opens": {
|
| 221 | + "description": "Number of unique opens recorded", |
175 | 222 | "type": ["null", "number"]
|
176 | 223 | },
|
177 | 224 | "open_rate": {
|
| 225 | + "description": "The open rate for the automation", |
178 | 226 | "type": ["null", "number"]
|
179 | 227 | },
|
180 | 228 | "clicks": {
|
| 229 | + "description": "The total number of clicks generated", |
181 | 230 | "type": ["null", "number"]
|
182 | 231 | },
|
183 | 232 | "subscriber_clicks": {
|
| 233 | + "description": "Number of clicks per subscriber", |
184 | 234 | "type": ["null", "number"]
|
185 | 235 | },
|
186 | 236 | "click_rate": {
|
| 237 | + "description": "The click-through rate for the automation", |
187 | 238 | "type": ["null", "number"]
|
188 | 239 | }
|
189 | 240 | }
|
|
0 commit comments