@graph8/sdk 0.277.0 → 0.293.0

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 (48) hide show
  1. package/dist/index.d.mts +601 -11
  2. package/dist/index.d.ts +601 -11
  3. package/dist/index.js +4 -2
  4. package/dist/index.js.map +1 -1
  5. package/dist/index.mjs +4 -2
  6. package/dist/index.mjs.map +1 -1
  7. package/dist/react.d.mts +593 -8
  8. package/dist/react.d.ts +593 -8
  9. package/dist/react.js +3 -1
  10. package/dist/react.js.map +1 -1
  11. package/dist/react.mjs +3 -1
  12. package/dist/react.mjs.map +1 -1
  13. package/dist/types/version.d.ts +2 -2
  14. package/docs/agents.md +4 -4
  15. package/docs/api/README.md +3 -3
  16. package/docs/api/analytics.d.ts +26 -1
  17. package/docs/api/analytics.md +2 -0
  18. package/docs/api/assertUpsert.d.ts +2 -0
  19. package/docs/api/assertUpsert.md +1 -0
  20. package/docs/api/audienceSyncs.d.ts +8 -0
  21. package/docs/api/audienceSyncs.md +16 -0
  22. package/docs/api/by-path.md +2 -0
  23. package/docs/api/companies.d.ts +7 -1
  24. package/docs/api/companies.md +4 -1
  25. package/docs/api/contacts.d.ts +7 -1
  26. package/docs/api/contacts.md +4 -1
  27. package/docs/api/enrichment.d.ts +76 -2
  28. package/docs/api/enrichment.md +76 -1
  29. package/docs/api/fields.d.ts +24 -3
  30. package/docs/api/fields.md +15 -4
  31. package/docs/api/install.d.ts +26 -0
  32. package/docs/api/install.md +18 -0
  33. package/docs/api/intent.d.ts +26 -1
  34. package/docs/api/intent.md +23 -0
  35. package/docs/api/lists.d.ts +9 -0
  36. package/docs/api/lists.md +17 -2
  37. package/docs/api/marketingIntelligence.d.ts +40 -0
  38. package/docs/api/marketingIntelligence.md +20 -0
  39. package/docs/api/snippet.d.ts +66 -2
  40. package/docs/api/snippet.md +73 -4
  41. package/docs/api/suppressions.d.ts +4 -0
  42. package/docs/api/suppressions.md +2 -0
  43. package/docs/api/visitors.d.ts +26 -0
  44. package/docs/api/visitors.md +12 -0
  45. package/docs/api/webAnalytics.d.ts +288 -0
  46. package/docs/api/webAnalytics.md +144 -0
  47. package/docs/api/workflows.md +6 -0
  48. package/package.json +1 -1
@@ -84,9 +84,13 @@ Get UTM campaign performance.
84
84
  |---|---|---|---|
85
85
  | `query.limit` | `integer` | no | Number of campaigns to return default `50` |
86
86
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
87
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
88
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
87
89
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
88
90
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
89
91
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
92
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
93
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
90
94
  | `headers.X-Org-Id` | `string \| null` | no | |
91
95
 
92
96
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -122,9 +126,13 @@ Paid Social, Email, Referral, Display, Affiliates, Other.
122
126
  | Field | Type | Required | Description |
123
127
  |---|---|---|---|
124
128
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
129
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
130
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
125
131
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
126
132
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
127
133
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
134
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
135
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
128
136
  | `headers.X-Org-Id` | `string \| null` | no | |
129
137
 
130
138
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -157,9 +165,13 @@ Get daily channel breakdown for stacked area charts.
157
165
  | Field | Type | Required | Description |
158
166
  |---|---|---|---|
159
167
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
168
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
169
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
160
170
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
161
171
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
162
172
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
173
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
174
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
163
175
  | `headers.X-Org-Id` | `string \| null` | no | |
164
176
 
165
177
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -193,9 +205,13 @@ Get top referring domains.
193
205
  |---|---|---|---|
194
206
  | `query.limit` | `integer` | no | Number of referrers to return default `50` |
195
207
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
208
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
209
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
196
210
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
197
211
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
198
212
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
213
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
214
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
199
215
  | `headers.X-Org-Id` | `string \| null` | no | |
200
216
 
201
217
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -228,9 +244,13 @@ Get acquisition from search engines.
228
244
  | Field | Type | Required | Description |
229
245
  |---|---|---|---|
230
246
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
247
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
248
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
231
249
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
232
250
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
233
251
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
252
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
253
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
234
254
  | `headers.X-Org-Id` | `string \| null` | no | |
235
255
 
236
256
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -263,9 +283,13 @@ Get acquisition from social networks.
263
283
  | Field | Type | Required | Description |
264
284
  |---|---|---|---|
265
285
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
286
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
287
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
266
288
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
267
289
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
268
290
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
291
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
292
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
269
293
  | `headers.X-Org-Id` | `string \| null` | no | |
270
294
 
271
295
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -299,9 +323,13 @@ Get acquisition by source/medium combination.
299
323
  |---|---|---|---|
300
324
  | `query.limit` | `integer` | no | Number of sources to return default `50` |
301
325
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
326
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
327
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
302
328
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
303
329
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
304
330
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
331
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
332
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
305
333
  | `headers.X-Org-Id` | `string \| null` | no | |
306
334
 
307
335
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -334,9 +362,13 @@ Get new vs returning visitors breakdown.
334
362
  | Field | Type | Required | Description |
335
363
  |---|---|---|---|
336
364
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
365
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
366
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
337
367
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
338
368
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
339
369
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
370
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
371
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
340
372
  | `headers.X-Org-Id` | `string \| null` | no | |
341
373
 
342
374
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -372,9 +404,13 @@ Returns top 10 entries for each category.
372
404
  | Field | Type | Required | Description |
373
405
  |---|---|---|---|
374
406
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
407
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
408
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
375
409
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
376
410
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
377
411
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
412
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
413
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
378
414
  | `headers.X-Org-Id` | `string \| null` | no | |
379
415
 
380
416
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -408,9 +444,13 @@ Get visitor languages breakdown.
408
444
  |---|---|---|---|
409
445
  | `query.limit` | `integer` | no | Number of languages to return default `20` |
410
446
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
447
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
448
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
411
449
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
412
450
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
413
451
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
452
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
453
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
414
454
  | `headers.X-Org-Id` | `string \| null` | no | |
415
455
 
416
456
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -445,9 +485,13 @@ Get audience overview: total users, new users, sessions, page views.
445
485
  | Field | Type | Required | Description |
446
486
  |---|---|---|---|
447
487
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
488
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
489
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
448
490
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
449
491
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
450
492
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
493
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
494
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
451
495
  | `headers.X-Org-Id` | `string \| null` | no | |
452
496
 
453
497
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -482,9 +526,13 @@ Returns date, users, new_users, page_views, sessions per day.
482
526
  | Field | Type | Required | Description |
483
527
  |---|---|---|---|
484
528
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
529
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
530
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
485
531
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
486
532
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
487
533
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
534
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
535
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
488
536
  | `headers.X-Org-Id` | `string \| null` | no | |
489
537
 
490
538
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -517,9 +565,13 @@ Get overall visitor-to-conversion rate.
517
565
  | Field | Type | Required | Description |
518
566
  |---|---|---|---|
519
567
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
568
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
569
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
520
570
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
521
571
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
522
572
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
573
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
574
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
523
575
  | `headers.X-Org-Id` | `string \| null` | no | |
524
576
 
525
577
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -556,9 +608,13 @@ Extended campaign metrics including engagement quality.
556
608
  |---|---|---|---|
557
609
  | `query.limit` | `integer` | no | Number of campaigns to return default `50` |
558
610
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
611
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
612
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
559
613
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
560
614
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
561
615
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
616
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
617
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
562
618
  | `headers.X-Org-Id` | `string \| null` | no | |
563
619
 
564
620
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -593,9 +649,13 @@ Shows which channels drive best engagement quality.
593
649
  | Field | Type | Required | Description |
594
650
  |---|---|---|---|
595
651
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
652
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
653
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
596
654
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
597
655
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
598
656
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
657
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
658
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
599
659
  | `headers.X-Org-Id` | `string \| null` | no | |
600
660
 
601
661
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -632,9 +692,13 @@ Only includes pages with at least 10 sessions.
632
692
  |---|---|---|---|
633
693
  | `query.limit` | `integer` | no | Number of pages to return default `20` |
634
694
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
695
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
696
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
635
697
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
636
698
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
637
699
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
700
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
701
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
638
702
  | `headers.X-Org-Id` | `string \| null` | no | |
639
703
 
640
704
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -678,9 +742,13 @@ Returns:
678
742
  | Field | Type | Required | Description |
679
743
  |---|---|---|---|
680
744
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
745
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
746
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
681
747
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
682
748
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
683
749
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
750
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
751
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
684
752
  | `headers.X-Org-Id` | `string \| null` | no | |
685
753
 
686
754
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -720,9 +788,13 @@ Returns daily breakdown of:
720
788
  | Field | Type | Required | Description |
721
789
  |---|---|---|---|
722
790
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
791
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
792
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
723
793
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
724
794
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
725
795
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
796
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
797
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
726
798
  | `headers.X-Org-Id` | `string \| null` | no | |
727
799
 
728
800
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -756,9 +828,13 @@ Get custom events summary (track events).
756
828
  |---|---|---|---|
757
829
  | `query.limit` | `integer` | no | Number of events to return default `50` |
758
830
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
831
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
832
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
759
833
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
760
834
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
761
835
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
836
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
837
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
762
838
  | `headers.X-Org-Id` | `string \| null` | no | |
763
839
 
764
840
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -792,9 +868,13 @@ Get top exit pages (last pages in sessions).
792
868
  |---|---|---|---|
793
869
  | `query.limit` | `integer` | no | Number of pages to return default `50` |
794
870
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
871
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
872
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
795
873
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
796
874
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
797
875
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
876
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
877
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
798
878
  | `headers.X-Org-Id` | `string \| null` | no | |
799
879
 
800
880
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -828,9 +908,13 @@ Get detailed form analysis with conversion rates.
828
908
  |---|---|---|---|
829
909
  | `query.limit` | `integer` | no | Number of forms to return default `20` |
830
910
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
911
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
912
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
831
913
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
832
914
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
833
915
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
916
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
917
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
834
918
  | `headers.X-Org-Id` | `string \| null` | no | |
835
919
 
836
920
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -864,9 +948,13 @@ Get form submission analytics.
864
948
  |---|---|---|---|
865
949
  | `query.limit` | `integer` | no | Number of forms to return default `50` |
866
950
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
951
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
952
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
867
953
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
868
954
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
869
955
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
956
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
957
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
870
958
  | `headers.X-Org-Id` | `string \| null` | no | |
871
959
 
872
960
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -899,9 +987,13 @@ Get daily form submissions trend.
899
987
  | Field | Type | Required | Description |
900
988
  |---|---|---|---|
901
989
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
990
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
991
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
902
992
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
903
993
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
904
994
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
995
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
996
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
905
997
  | `headers.X-Org-Id` | `string \| null` | no | |
906
998
 
907
999
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -936,9 +1028,13 @@ Default funnel: Site Visitors → Viewed Form → Submitted Form → Booked Meet
936
1028
  | Field | Type | Required | Description |
937
1029
  |---|---|---|---|
938
1030
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
1031
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
1032
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
939
1033
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
940
1034
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
941
1035
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
1036
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
1037
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
942
1038
  | `headers.X-Org-Id` | `string \| null` | no | |
943
1039
 
944
1040
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -972,9 +1068,13 @@ Get geographic distribution by city.
972
1068
  |---|---|---|---|
973
1069
  | `query.limit` | `integer` | no | Number of cities to return default `50` |
974
1070
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
1071
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
1072
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
975
1073
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
976
1074
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
977
1075
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
1076
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
1077
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
978
1078
  | `headers.X-Org-Id` | `string \| null` | no | |
979
1079
 
980
1080
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -1008,9 +1108,13 @@ Get geographic distribution by country.
1008
1108
  |---|---|---|---|
1009
1109
  | `query.limit` | `integer` | no | Number of countries to return default `50` |
1010
1110
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
1111
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
1112
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
1011
1113
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
1012
1114
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
1013
1115
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
1116
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
1117
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
1014
1118
  | `headers.X-Org-Id` | `string \| null` | no | |
1015
1119
 
1016
1120
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -1046,9 +1150,13 @@ Goals: Form Submissions, Meeting Booked, Signup, Purchase.
1046
1150
  | Field | Type | Required | Description |
1047
1151
  |---|---|---|---|
1048
1152
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
1153
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
1154
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
1049
1155
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
1050
1156
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
1051
1157
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
1158
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
1159
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
1052
1160
  | `headers.X-Org-Id` | `string \| null` | no | |
1053
1161
 
1054
1162
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -1081,9 +1189,13 @@ Get daily trend for goal completions.
1081
1189
  | Field | Type | Required | Description |
1082
1190
  |---|---|---|---|
1083
1191
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
1192
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
1193
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
1084
1194
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
1085
1195
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
1086
1196
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
1197
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
1198
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
1087
1199
  | `headers.X-Org-Id` | `string \| null` | no | |
1088
1200
 
1089
1201
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -1117,9 +1229,13 @@ Get top landing pages (entry pages).
1117
1229
  |---|---|---|---|
1118
1230
  | `query.limit` | `integer` | no | Number of pages to return default `50` |
1119
1231
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
1232
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
1233
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
1120
1234
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
1121
1235
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
1122
1236
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
1237
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
1238
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
1123
1239
  | `headers.X-Org-Id` | `string \| null` | no | |
1124
1240
 
1125
1241
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -1157,9 +1273,13 @@ the strict charset check here is the boundary defense, mirroring
1157
1273
  |---|---|---|---|
1158
1274
  | `query.path` | `string` | yes | Exact context_page_path to roll up |
1159
1275
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
1276
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
1277
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
1160
1278
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
1161
1279
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
1162
1280
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
1281
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
1282
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
1163
1283
  | `headers.X-Org-Id` | `string \| null` | no | |
1164
1284
 
1165
1285
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -1195,6 +1315,8 @@ Get real-time analytics: active users in last 5 and 30 minutes.
1195
1315
  | Field | Type | Required | Description |
1196
1316
  |---|---|---|---|
1197
1317
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
1318
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
1319
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
1198
1320
  | `headers.X-Org-Id` | `string \| null` | no | |
1199
1321
 
1200
1322
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -1228,6 +1350,8 @@ Get active locations in real-time (last 5 minutes).
1228
1350
  |---|---|---|---|
1229
1351
  | `query.limit` | `integer \| null` | no | Number of locations to return |
1230
1352
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
1353
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
1354
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
1231
1355
  | `headers.X-Org-Id` | `string \| null` | no | |
1232
1356
 
1233
1357
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -1261,6 +1385,8 @@ Get active pages in real-time (last 5 minutes).
1261
1385
  |---|---|---|---|
1262
1386
  | `query.limit` | `integer` | no | Number of pages to return default `10` |
1263
1387
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
1388
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
1389
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
1264
1390
  | `headers.X-Org-Id` | `string \| null` | no | |
1265
1391
 
1266
1392
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -1294,6 +1420,8 @@ Get traffic sources in real-time (last 5 minutes).
1294
1420
  |---|---|---|---|
1295
1421
  | `query.limit` | `integer` | no | Number of sources to return default `10` |
1296
1422
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
1423
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
1424
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
1297
1425
  | `headers.X-Org-Id` | `string \| null` | no | |
1298
1426
 
1299
1427
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -1328,9 +1456,13 @@ Returns buckets: 1 page, 2 pages, 3 pages, 4-5 pages, 6-10 pages, 10+ pages.
1328
1456
  | Field | Type | Required | Description |
1329
1457
  |---|---|---|---|
1330
1458
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
1459
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
1460
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
1331
1461
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
1332
1462
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
1333
1463
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
1464
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
1465
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
1334
1466
  | `headers.X-Org-Id` | `string \| null` | no | |
1335
1467
 
1336
1468
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -1363,9 +1495,13 @@ Get technology overview: browsers, OS, and devices combined.
1363
1495
  | Field | Type | Required | Description |
1364
1496
  |---|---|---|---|
1365
1497
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
1498
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
1499
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
1366
1500
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
1367
1501
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
1368
1502
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
1503
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
1504
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
1369
1505
  | `headers.X-Org-Id` | `string \| null` | no | |
1370
1506
 
1371
1507
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -1400,9 +1536,13 @@ Returns buckets: 0s (bounce), 1-30s, 30s-1m, 1-3m, 3-10m, 10m+.
1400
1536
  | Field | Type | Required | Description |
1401
1537
  |---|---|---|---|
1402
1538
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
1539
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
1540
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
1403
1541
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
1404
1542
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
1405
1543
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
1544
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
1545
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
1406
1546
  | `headers.X-Org-Id` | `string \| null` | no | |
1407
1547
 
1408
1548
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -1436,9 +1576,13 @@ Get top pages by views and unique visitors.
1436
1576
  |---|---|---|---|
1437
1577
  | `query.limit` | `integer` | no | Number of pages to return default `50` |
1438
1578
  | `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
1579
+ | `query.include_bots` | `boolean` | no | Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. default `false` |
1580
+ | `query.include_internal` | `boolean` | no | Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. default `false` |
1439
1581
  | `query.days` | `integer` | no | Number of days to analyze default `30` |
1440
1582
  | `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
1441
1583
  | `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
1584
+ | `query.start_date` | `string \| null` | no | Alias of date_from (YYYY-MM-DD), the name the other analytics reports use. Sent alone, the window runs from start_date to today (UTC). |
1585
+ | `query.end_date` | `string \| null` | no | Alias of date_to (YYYY-MM-DD). Sent alone, the window is the `days` days ending on end_date. |
1442
1586
  | `headers.X-Org-Id` | `string \| null` | no | |
1443
1587
 
1444
1588
  **Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -577,6 +577,12 @@ Pins ``org_id`` server-side; the caller cannot override which org's
577
577
  execution row is created. ``triggered_by`` defaults to the caller's
578
578
  user id when not supplied.
579
579
 
580
+ If the workflow service takes the request but does not answer in time,
581
+ the answer is ``202`` with ``outcome`` ``started`` (run found, with its
582
+ ``execution_id``) or ``unknown`` (check the executions list first), not a
583
+ 502: the run may well be going. Send an ``Idempotency-Key`` to make retries
584
+ safe; a retry with the same key returns the first answer.
585
+
580
586
  **Input**
581
587
 
582
588
  | Field | Type | Required | Description |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@graph8/sdk",
3
- "version": "0.277.0",
3
+ "version": "0.293.0",
4
4
  "description": "graph8 SDK - CRM, enrichment, sequences, campaigns, and tracking for B2B",
5
5
  "license": "MIT",
6
6
  "author": "graph8 <support@graph8.com> (https://graph8.com)",