@aifeatures/backend 0.15.0 → 0.16.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.
- package/dist/index.d.cts +145 -2
- package/dist/index.d.ts +145 -2
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1412,6 +1412,19 @@ type BusinessSummary = {
|
|
|
1412
1412
|
available: number;
|
|
1413
1413
|
}>;
|
|
1414
1414
|
};
|
|
1415
|
+
/**
|
|
1416
|
+
* Durable capabilities, unbounded in time — a storefront that last sold in March is still a storefront.
|
|
1417
|
+
*/
|
|
1418
|
+
commerce: {
|
|
1419
|
+
/**
|
|
1420
|
+
* This site has invoiced at least once. NOT derivable from the other fields: an unpaid invoice is `pending`, outside the revenue family, and a service business has no catalogue.
|
|
1421
|
+
*/
|
|
1422
|
+
invoicing: boolean;
|
|
1423
|
+
/**
|
|
1424
|
+
* This site has at least one non-invoice order in the revenue family. `revenue.*.orders` cannot answer this: it counts invoice-sourced rows too, while GET /orders excludes them by default.
|
|
1425
|
+
*/
|
|
1426
|
+
storefront_orders: boolean;
|
|
1427
|
+
};
|
|
1415
1428
|
/**
|
|
1416
1429
|
* The 7-day traffic tile, or null when the site has no analytics id or the source is unreachable. Null costs the merchant this tile and nothing else: the commerce figures beside it are unaffected by a Tinybird outage.
|
|
1417
1430
|
*/
|
|
@@ -1434,6 +1447,10 @@ type BusinessSummary = {
|
|
|
1434
1447
|
from: string;
|
|
1435
1448
|
to: string;
|
|
1436
1449
|
};
|
|
1450
|
+
/**
|
|
1451
|
+
* The IANA zone this tile's days were bucketed and bounded in — the same field every analytics report carries, for the same reason: it is not guaranteed to equal the `timezone` asked for, since an unusable value falls back to the site's stored zone. The tile and the Analytics panel resolve one window, so they must also agree about which zone it is.
|
|
1452
|
+
*/
|
|
1453
|
+
timezone: string;
|
|
1437
1454
|
} | null;
|
|
1438
1455
|
};
|
|
1439
1456
|
type SalesSummarySeriesEntry = {
|
|
@@ -1667,6 +1684,10 @@ type AnalyticsSummary = {
|
|
|
1667
1684
|
from: string;
|
|
1668
1685
|
to: string;
|
|
1669
1686
|
};
|
|
1687
|
+
/**
|
|
1688
|
+
* The IANA zone this report's local days were bucketed and bounded in. ON THE PAYLOAD, not to be paired with a separate /status call: per-report fetching means /status failing while this one succeeds is a routine outcome, and the window bounds above are UTC instants standing for LOCAL midnights, so reading them in the wrong zone shifts a site east of UTC by a whole day. It is also not guaranteed to equal the `timezone` you asked for — an unusable value falls back to the site's stored zone and then to UTC — so this field, never the request, is what the numbers are in.
|
|
1689
|
+
*/
|
|
1690
|
+
timezone: string;
|
|
1670
1691
|
} | {
|
|
1671
1692
|
status: "unreachable";
|
|
1672
1693
|
};
|
|
@@ -1701,7 +1722,7 @@ type AnalyticsTimeseries = {
|
|
|
1701
1722
|
to: string;
|
|
1702
1723
|
};
|
|
1703
1724
|
/**
|
|
1704
|
-
* The IANA zone
|
|
1725
|
+
* The IANA zone this report's local days were bucketed and bounded in. ON THE PAYLOAD, not to be paired with a separate /status call: per-report fetching means /status failing while this one succeeds is a routine outcome, and the window bounds above are UTC instants standing for LOCAL midnights, so reading them in the wrong zone shifts a site east of UTC by a whole day. It is also not guaranteed to equal the `timezone` you asked for — an unusable value falls back to the site's stored zone and then to UTC — so this field, never the request, is what the numbers are in.
|
|
1705
1726
|
*/
|
|
1706
1727
|
timezone: string;
|
|
1707
1728
|
} | {
|
|
@@ -1724,10 +1745,17 @@ type AnalyticsBreakdown = {
|
|
|
1724
1745
|
data: Array<{
|
|
1725
1746
|
[key: string]: string | number | null | Array<string>;
|
|
1726
1747
|
}>;
|
|
1748
|
+
/**
|
|
1749
|
+
* The half-open UTC window the values were measured over: from inclusive, to exclusive. Resolved from the site's reporting timezone.
|
|
1750
|
+
*/
|
|
1727
1751
|
window: {
|
|
1728
1752
|
from: string;
|
|
1729
1753
|
to: string;
|
|
1730
1754
|
};
|
|
1755
|
+
/**
|
|
1756
|
+
* The IANA zone this report's local days were bucketed and bounded in. ON THE PAYLOAD, not to be paired with a separate /status call: per-report fetching means /status failing while this one succeeds is a routine outcome, and the window bounds above are UTC instants standing for LOCAL midnights, so reading them in the wrong zone shifts a site east of UTC by a whole day. It is also not guaranteed to equal the `timezone` you asked for — an unusable value falls back to the site's stored zone and then to UTC — so this field, never the request, is what the numbers are in.
|
|
1757
|
+
*/
|
|
1758
|
+
timezone: string;
|
|
1731
1759
|
} | {
|
|
1732
1760
|
status: "unreachable";
|
|
1733
1761
|
};
|
|
@@ -1737,10 +1765,17 @@ type AnalyticsChannels = {
|
|
|
1737
1765
|
channel: string;
|
|
1738
1766
|
visits: number;
|
|
1739
1767
|
}>;
|
|
1768
|
+
/**
|
|
1769
|
+
* The half-open UTC window the values were measured over: from inclusive, to exclusive. Resolved from the site's reporting timezone.
|
|
1770
|
+
*/
|
|
1740
1771
|
window: {
|
|
1741
1772
|
from: string;
|
|
1742
1773
|
to: string;
|
|
1743
1774
|
};
|
|
1775
|
+
/**
|
|
1776
|
+
* The IANA zone this report's local days were bucketed and bounded in. ON THE PAYLOAD, not to be paired with a separate /status call: per-report fetching means /status failing while this one succeeds is a routine outcome, and the window bounds above are UTC instants standing for LOCAL midnights, so reading them in the wrong zone shifts a site east of UTC by a whole day. It is also not guaranteed to equal the `timezone` you asked for — an unusable value falls back to the site's stored zone and then to UTC — so this field, never the request, is what the numbers are in.
|
|
1777
|
+
*/
|
|
1778
|
+
timezone: string;
|
|
1744
1779
|
} | {
|
|
1745
1780
|
status: "unreachable";
|
|
1746
1781
|
};
|
|
@@ -4831,6 +4866,10 @@ type GetBusinessSummaryData = {
|
|
|
4831
4866
|
* Minutes to ADD to UTC for the merchant's local time (browser: -new Date().getTimezoneOffset()). Buckets 'today' and daily series on the merchant's calendar, not UTC's — omit for UTC. Clamped to ±840.
|
|
4832
4867
|
*/
|
|
4833
4868
|
tz_offset_minutes?: string;
|
|
4869
|
+
/**
|
|
4870
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
4871
|
+
*/
|
|
4872
|
+
timezone?: string;
|
|
4834
4873
|
};
|
|
4835
4874
|
url: "/api/v1/summary";
|
|
4836
4875
|
};
|
|
@@ -5036,6 +5075,10 @@ type GetAnalyticsStatusData = {
|
|
|
5036
5075
|
* Required when authenticating with an organization API key — scopes the call to one site in your org. Optional with a site token, and must match that token's site.
|
|
5037
5076
|
*/
|
|
5038
5077
|
site_id?: string;
|
|
5078
|
+
/**
|
|
5079
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5080
|
+
*/
|
|
5081
|
+
timezone?: string;
|
|
5039
5082
|
};
|
|
5040
5083
|
url: "/api/v1/analytics/status";
|
|
5041
5084
|
};
|
|
@@ -5068,6 +5111,10 @@ type GetAnalyticsSummaryData = {
|
|
|
5068
5111
|
* Days covered, ending at the most recent midnight in the site's reporting timezone. Today's partial day is EXCLUDED - including it would compare a complete period against a few hours and read as a traffic collapse every morning. Defaults to 30.
|
|
5069
5112
|
*/
|
|
5070
5113
|
period?: "7" | "30" | "90";
|
|
5114
|
+
/**
|
|
5115
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5116
|
+
*/
|
|
5117
|
+
timezone?: string;
|
|
5071
5118
|
/**
|
|
5072
5119
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5073
5120
|
*/
|
|
@@ -5112,6 +5159,10 @@ type GetAnalyticsTimeseriesData = {
|
|
|
5112
5159
|
* Days covered, ending at the most recent midnight in the site's reporting timezone. Today's partial day is EXCLUDED - including it would compare a complete period against a few hours and read as a traffic collapse every morning. Defaults to 30.
|
|
5113
5160
|
*/
|
|
5114
5161
|
period?: "7" | "30" | "90";
|
|
5162
|
+
/**
|
|
5163
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5164
|
+
*/
|
|
5165
|
+
timezone?: string;
|
|
5115
5166
|
/**
|
|
5116
5167
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5117
5168
|
*/
|
|
@@ -5178,6 +5229,10 @@ type GetAnalyticsSourcesData = {
|
|
|
5178
5229
|
query?: {
|
|
5179
5230
|
site_id?: string;
|
|
5180
5231
|
period?: "7" | "30" | "90";
|
|
5232
|
+
/**
|
|
5233
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5234
|
+
*/
|
|
5235
|
+
timezone?: string;
|
|
5181
5236
|
/**
|
|
5182
5237
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5183
5238
|
*/
|
|
@@ -5218,6 +5273,10 @@ type GetAnalyticsCampaignsData = {
|
|
|
5218
5273
|
query?: {
|
|
5219
5274
|
site_id?: string;
|
|
5220
5275
|
period?: "7" | "30" | "90";
|
|
5276
|
+
/**
|
|
5277
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5278
|
+
*/
|
|
5279
|
+
timezone?: string;
|
|
5221
5280
|
/**
|
|
5222
5281
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5223
5282
|
*/
|
|
@@ -5258,6 +5317,10 @@ type GetAnalyticsUtmMediumData = {
|
|
|
5258
5317
|
query?: {
|
|
5259
5318
|
site_id?: string;
|
|
5260
5319
|
period?: "7" | "30" | "90";
|
|
5320
|
+
/**
|
|
5321
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5322
|
+
*/
|
|
5323
|
+
timezone?: string;
|
|
5261
5324
|
/**
|
|
5262
5325
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5263
5326
|
*/
|
|
@@ -5298,6 +5361,10 @@ type GetAnalyticsUtmSourceData = {
|
|
|
5298
5361
|
query?: {
|
|
5299
5362
|
site_id?: string;
|
|
5300
5363
|
period?: "7" | "30" | "90";
|
|
5364
|
+
/**
|
|
5365
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5366
|
+
*/
|
|
5367
|
+
timezone?: string;
|
|
5301
5368
|
/**
|
|
5302
5369
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5303
5370
|
*/
|
|
@@ -5338,6 +5405,10 @@ type GetAnalyticsUtmCampaignData = {
|
|
|
5338
5405
|
query?: {
|
|
5339
5406
|
site_id?: string;
|
|
5340
5407
|
period?: "7" | "30" | "90";
|
|
5408
|
+
/**
|
|
5409
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5410
|
+
*/
|
|
5411
|
+
timezone?: string;
|
|
5341
5412
|
/**
|
|
5342
5413
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5343
5414
|
*/
|
|
@@ -5378,6 +5449,10 @@ type GetAnalyticsUtmContentData = {
|
|
|
5378
5449
|
query?: {
|
|
5379
5450
|
site_id?: string;
|
|
5380
5451
|
period?: "7" | "30" | "90";
|
|
5452
|
+
/**
|
|
5453
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5454
|
+
*/
|
|
5455
|
+
timezone?: string;
|
|
5381
5456
|
/**
|
|
5382
5457
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5383
5458
|
*/
|
|
@@ -5418,6 +5493,10 @@ type GetAnalyticsUtmTermData = {
|
|
|
5418
5493
|
query?: {
|
|
5419
5494
|
site_id?: string;
|
|
5420
5495
|
period?: "7" | "30" | "90";
|
|
5496
|
+
/**
|
|
5497
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5498
|
+
*/
|
|
5499
|
+
timezone?: string;
|
|
5421
5500
|
/**
|
|
5422
5501
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5423
5502
|
*/
|
|
@@ -5458,6 +5537,10 @@ type GetAnalyticsPagesData = {
|
|
|
5458
5537
|
query?: {
|
|
5459
5538
|
site_id?: string;
|
|
5460
5539
|
period?: "7" | "30" | "90";
|
|
5540
|
+
/**
|
|
5541
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5542
|
+
*/
|
|
5543
|
+
timezone?: string;
|
|
5461
5544
|
/**
|
|
5462
5545
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5463
5546
|
*/
|
|
@@ -5498,6 +5581,10 @@ type GetAnalyticsEntryPagesData = {
|
|
|
5498
5581
|
query?: {
|
|
5499
5582
|
site_id?: string;
|
|
5500
5583
|
period?: "7" | "30" | "90";
|
|
5584
|
+
/**
|
|
5585
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5586
|
+
*/
|
|
5587
|
+
timezone?: string;
|
|
5501
5588
|
/**
|
|
5502
5589
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5503
5590
|
*/
|
|
@@ -5538,6 +5625,10 @@ type GetAnalyticsExitPagesData = {
|
|
|
5538
5625
|
query?: {
|
|
5539
5626
|
site_id?: string;
|
|
5540
5627
|
period?: "7" | "30" | "90";
|
|
5628
|
+
/**
|
|
5629
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5630
|
+
*/
|
|
5631
|
+
timezone?: string;
|
|
5541
5632
|
/**
|
|
5542
5633
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5543
5634
|
*/
|
|
@@ -5578,6 +5669,10 @@ type GetAnalyticsCountriesData = {
|
|
|
5578
5669
|
query?: {
|
|
5579
5670
|
site_id?: string;
|
|
5580
5671
|
period?: "7" | "30" | "90";
|
|
5672
|
+
/**
|
|
5673
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5674
|
+
*/
|
|
5675
|
+
timezone?: string;
|
|
5581
5676
|
/**
|
|
5582
5677
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5583
5678
|
*/
|
|
@@ -5618,6 +5713,10 @@ type GetAnalyticsRegionsData = {
|
|
|
5618
5713
|
query?: {
|
|
5619
5714
|
site_id?: string;
|
|
5620
5715
|
period?: "7" | "30" | "90";
|
|
5716
|
+
/**
|
|
5717
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5718
|
+
*/
|
|
5719
|
+
timezone?: string;
|
|
5621
5720
|
/**
|
|
5622
5721
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5623
5722
|
*/
|
|
@@ -5658,6 +5757,10 @@ type GetAnalyticsCitiesData = {
|
|
|
5658
5757
|
query?: {
|
|
5659
5758
|
site_id?: string;
|
|
5660
5759
|
period?: "7" | "30" | "90";
|
|
5760
|
+
/**
|
|
5761
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5762
|
+
*/
|
|
5763
|
+
timezone?: string;
|
|
5661
5764
|
/**
|
|
5662
5765
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5663
5766
|
*/
|
|
@@ -5698,6 +5801,10 @@ type GetAnalyticsDevicesData = {
|
|
|
5698
5801
|
query?: {
|
|
5699
5802
|
site_id?: string;
|
|
5700
5803
|
period?: "7" | "30" | "90";
|
|
5804
|
+
/**
|
|
5805
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5806
|
+
*/
|
|
5807
|
+
timezone?: string;
|
|
5701
5808
|
/**
|
|
5702
5809
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5703
5810
|
*/
|
|
@@ -5738,6 +5845,10 @@ type GetAnalyticsBrowsersData = {
|
|
|
5738
5845
|
query?: {
|
|
5739
5846
|
site_id?: string;
|
|
5740
5847
|
period?: "7" | "30" | "90";
|
|
5848
|
+
/**
|
|
5849
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5850
|
+
*/
|
|
5851
|
+
timezone?: string;
|
|
5741
5852
|
/**
|
|
5742
5853
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5743
5854
|
*/
|
|
@@ -5778,6 +5889,10 @@ type GetAnalyticsOperatingSystemsData = {
|
|
|
5778
5889
|
query?: {
|
|
5779
5890
|
site_id?: string;
|
|
5780
5891
|
period?: "7" | "30" | "90";
|
|
5892
|
+
/**
|
|
5893
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5894
|
+
*/
|
|
5895
|
+
timezone?: string;
|
|
5781
5896
|
/**
|
|
5782
5897
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5783
5898
|
*/
|
|
@@ -5818,6 +5933,10 @@ type GetAnalyticsChannelsData = {
|
|
|
5818
5933
|
query?: {
|
|
5819
5934
|
site_id?: string;
|
|
5820
5935
|
period?: "7" | "30" | "90";
|
|
5936
|
+
/**
|
|
5937
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5938
|
+
*/
|
|
5939
|
+
timezone?: string;
|
|
5821
5940
|
/**
|
|
5822
5941
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5823
5942
|
*/
|
|
@@ -5863,6 +5982,10 @@ type GetAnalyticsGoalTargetsData = {
|
|
|
5863
5982
|
* Days covered, ending at the most recent midnight in the site's reporting timezone. Today's partial day is EXCLUDED - including it would compare a complete period against a few hours and read as a traffic collapse every morning. Defaults to 30.
|
|
5864
5983
|
*/
|
|
5865
5984
|
period?: "7" | "30" | "90";
|
|
5985
|
+
/**
|
|
5986
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5987
|
+
*/
|
|
5988
|
+
timezone?: string;
|
|
5866
5989
|
/**
|
|
5867
5990
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5868
5991
|
*/
|
|
@@ -5930,6 +6053,10 @@ type GetAnalyticsGoalTargetsResponses = {
|
|
|
5930
6053
|
from: string;
|
|
5931
6054
|
to: string;
|
|
5932
6055
|
};
|
|
6056
|
+
/**
|
|
6057
|
+
* The IANA zone this report's local days were bucketed and bounded in. ON THE PAYLOAD, not to be paired with a separate /status call: per-report fetching means /status failing while this one succeeds is a routine outcome, and the window bounds above are UTC instants standing for LOCAL midnights, so reading them in the wrong zone shifts a site east of UTC by a whole day. It is also not guaranteed to equal the `timezone` you asked for — an unusable value falls back to the site's stored zone and then to UTC — so this field, never the request, is what the numbers are in.
|
|
6058
|
+
*/
|
|
6059
|
+
timezone: string;
|
|
5933
6060
|
/**
|
|
5934
6061
|
* The goal these values belong to, echoed back so a client can label the table without trusting its own request.
|
|
5935
6062
|
*/
|
|
@@ -5976,6 +6103,10 @@ type GetAnalyticsConversionsData = {
|
|
|
5976
6103
|
* Days covered, ending at the most recent midnight in the site's reporting timezone. Today's partial day is EXCLUDED - including it would compare a complete period against a few hours and read as a traffic collapse every morning. Defaults to 30.
|
|
5977
6104
|
*/
|
|
5978
6105
|
period?: "7" | "30" | "90";
|
|
6106
|
+
/**
|
|
6107
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
6108
|
+
*/
|
|
6109
|
+
timezone?: string;
|
|
5979
6110
|
/**
|
|
5980
6111
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5981
6112
|
*/
|
|
@@ -6043,6 +6174,10 @@ type GetAnalyticsConversionsResponses = {
|
|
|
6043
6174
|
from: string;
|
|
6044
6175
|
to: string;
|
|
6045
6176
|
};
|
|
6177
|
+
/**
|
|
6178
|
+
* The IANA zone this report's local days were bucketed and bounded in. ON THE PAYLOAD, not to be paired with a separate /status call: per-report fetching means /status failing while this one succeeds is a routine outcome, and the window bounds above are UTC instants standing for LOCAL midnights, so reading them in the wrong zone shifts a site east of UTC by a whole day. It is also not guaranteed to equal the `timezone` you asked for — an unusable value falls back to the site's stored zone and then to UTC — so this field, never the request, is what the numbers are in.
|
|
6179
|
+
*/
|
|
6180
|
+
timezone: string;
|
|
6046
6181
|
/**
|
|
6047
6182
|
* Site-wide unique visitors for the window, with no goal filtering — the denominator every `conversion_rate` above divides by. Say what the rate is a ratio of wherever you show one: this is Plausible's definition and it surprises people, because the rates do not sum to 100%.
|
|
6048
6183
|
*/
|
|
@@ -6072,6 +6207,10 @@ type GetAnalyticsFunnelReportData = {
|
|
|
6072
6207
|
query?: {
|
|
6073
6208
|
site_id?: string;
|
|
6074
6209
|
period?: "7" | "30" | "90";
|
|
6210
|
+
/**
|
|
6211
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
6212
|
+
*/
|
|
6213
|
+
timezone?: string;
|
|
6075
6214
|
/**
|
|
6076
6215
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
6077
6216
|
*/
|
|
@@ -6139,6 +6278,10 @@ type GetAnalyticsFunnelReportResponses = {
|
|
|
6139
6278
|
from: string;
|
|
6140
6279
|
to: string;
|
|
6141
6280
|
};
|
|
6281
|
+
/**
|
|
6282
|
+
* The IANA zone this report's local days were bucketed and bounded in. ON THE PAYLOAD, not to be paired with a separate /status call: per-report fetching means /status failing while this one succeeds is a routine outcome, and the window bounds above are UTC instants standing for LOCAL midnights, so reading them in the wrong zone shifts a site east of UTC by a whole day. It is also not guaranteed to equal the `timezone` you asked for — an unusable value falls back to the site's stored zone and then to UTC — so this field, never the request, is what the numbers are in.
|
|
6283
|
+
*/
|
|
6284
|
+
timezone: string;
|
|
6142
6285
|
funnel: {
|
|
6143
6286
|
id: string;
|
|
6144
6287
|
display_name: string;
|
|
@@ -11138,7 +11281,7 @@ declare const setOrderFulfillment: <ThrowOnError extends boolean = false>(option
|
|
|
11138
11281
|
/**
|
|
11139
11282
|
* Collection status for a site (site token, or org key with site_id)
|
|
11140
11283
|
*
|
|
11141
|
-
* Whether this site can collect at all, the zone its reports are bucketed in, and when it first recorded anything. Ask this before rendering an empty panel: it separates 'not collecting' (no analytics identity - nothing will ever arrive) from 'collecting, no traffic yet', which need different things said to the merchant.
|
|
11284
|
+
* Whether this site can collect at all, the zone its reports are bucketed in, and when it first recorded anything. Ask this before rendering an empty panel: it separates 'not collecting' (no analytics identity - nothing will ever arrive) from 'collecting, no traffic yet', which need different things said to the merchant. SEND THE SAME `timezone` you send to the reports: this endpoint answers `timezone_defaulted` and compares `first_seen` against local day boundaries, so resolving it in a different zone than the reports makes it answer about days the reports are not describing.
|
|
11142
11285
|
*/
|
|
11143
11286
|
declare const getAnalyticsStatus: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsStatusData, ThrowOnError>) => RequestResult<GetAnalyticsStatusResponses, GetAnalyticsStatusErrors, ThrowOnError, "fields">;
|
|
11144
11287
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -1412,6 +1412,19 @@ type BusinessSummary = {
|
|
|
1412
1412
|
available: number;
|
|
1413
1413
|
}>;
|
|
1414
1414
|
};
|
|
1415
|
+
/**
|
|
1416
|
+
* Durable capabilities, unbounded in time — a storefront that last sold in March is still a storefront.
|
|
1417
|
+
*/
|
|
1418
|
+
commerce: {
|
|
1419
|
+
/**
|
|
1420
|
+
* This site has invoiced at least once. NOT derivable from the other fields: an unpaid invoice is `pending`, outside the revenue family, and a service business has no catalogue.
|
|
1421
|
+
*/
|
|
1422
|
+
invoicing: boolean;
|
|
1423
|
+
/**
|
|
1424
|
+
* This site has at least one non-invoice order in the revenue family. `revenue.*.orders` cannot answer this: it counts invoice-sourced rows too, while GET /orders excludes them by default.
|
|
1425
|
+
*/
|
|
1426
|
+
storefront_orders: boolean;
|
|
1427
|
+
};
|
|
1415
1428
|
/**
|
|
1416
1429
|
* The 7-day traffic tile, or null when the site has no analytics id or the source is unreachable. Null costs the merchant this tile and nothing else: the commerce figures beside it are unaffected by a Tinybird outage.
|
|
1417
1430
|
*/
|
|
@@ -1434,6 +1447,10 @@ type BusinessSummary = {
|
|
|
1434
1447
|
from: string;
|
|
1435
1448
|
to: string;
|
|
1436
1449
|
};
|
|
1450
|
+
/**
|
|
1451
|
+
* The IANA zone this tile's days were bucketed and bounded in — the same field every analytics report carries, for the same reason: it is not guaranteed to equal the `timezone` asked for, since an unusable value falls back to the site's stored zone. The tile and the Analytics panel resolve one window, so they must also agree about which zone it is.
|
|
1452
|
+
*/
|
|
1453
|
+
timezone: string;
|
|
1437
1454
|
} | null;
|
|
1438
1455
|
};
|
|
1439
1456
|
type SalesSummarySeriesEntry = {
|
|
@@ -1667,6 +1684,10 @@ type AnalyticsSummary = {
|
|
|
1667
1684
|
from: string;
|
|
1668
1685
|
to: string;
|
|
1669
1686
|
};
|
|
1687
|
+
/**
|
|
1688
|
+
* The IANA zone this report's local days were bucketed and bounded in. ON THE PAYLOAD, not to be paired with a separate /status call: per-report fetching means /status failing while this one succeeds is a routine outcome, and the window bounds above are UTC instants standing for LOCAL midnights, so reading them in the wrong zone shifts a site east of UTC by a whole day. It is also not guaranteed to equal the `timezone` you asked for — an unusable value falls back to the site's stored zone and then to UTC — so this field, never the request, is what the numbers are in.
|
|
1689
|
+
*/
|
|
1690
|
+
timezone: string;
|
|
1670
1691
|
} | {
|
|
1671
1692
|
status: "unreachable";
|
|
1672
1693
|
};
|
|
@@ -1701,7 +1722,7 @@ type AnalyticsTimeseries = {
|
|
|
1701
1722
|
to: string;
|
|
1702
1723
|
};
|
|
1703
1724
|
/**
|
|
1704
|
-
* The IANA zone
|
|
1725
|
+
* The IANA zone this report's local days were bucketed and bounded in. ON THE PAYLOAD, not to be paired with a separate /status call: per-report fetching means /status failing while this one succeeds is a routine outcome, and the window bounds above are UTC instants standing for LOCAL midnights, so reading them in the wrong zone shifts a site east of UTC by a whole day. It is also not guaranteed to equal the `timezone` you asked for — an unusable value falls back to the site's stored zone and then to UTC — so this field, never the request, is what the numbers are in.
|
|
1705
1726
|
*/
|
|
1706
1727
|
timezone: string;
|
|
1707
1728
|
} | {
|
|
@@ -1724,10 +1745,17 @@ type AnalyticsBreakdown = {
|
|
|
1724
1745
|
data: Array<{
|
|
1725
1746
|
[key: string]: string | number | null | Array<string>;
|
|
1726
1747
|
}>;
|
|
1748
|
+
/**
|
|
1749
|
+
* The half-open UTC window the values were measured over: from inclusive, to exclusive. Resolved from the site's reporting timezone.
|
|
1750
|
+
*/
|
|
1727
1751
|
window: {
|
|
1728
1752
|
from: string;
|
|
1729
1753
|
to: string;
|
|
1730
1754
|
};
|
|
1755
|
+
/**
|
|
1756
|
+
* The IANA zone this report's local days were bucketed and bounded in. ON THE PAYLOAD, not to be paired with a separate /status call: per-report fetching means /status failing while this one succeeds is a routine outcome, and the window bounds above are UTC instants standing for LOCAL midnights, so reading them in the wrong zone shifts a site east of UTC by a whole day. It is also not guaranteed to equal the `timezone` you asked for — an unusable value falls back to the site's stored zone and then to UTC — so this field, never the request, is what the numbers are in.
|
|
1757
|
+
*/
|
|
1758
|
+
timezone: string;
|
|
1731
1759
|
} | {
|
|
1732
1760
|
status: "unreachable";
|
|
1733
1761
|
};
|
|
@@ -1737,10 +1765,17 @@ type AnalyticsChannels = {
|
|
|
1737
1765
|
channel: string;
|
|
1738
1766
|
visits: number;
|
|
1739
1767
|
}>;
|
|
1768
|
+
/**
|
|
1769
|
+
* The half-open UTC window the values were measured over: from inclusive, to exclusive. Resolved from the site's reporting timezone.
|
|
1770
|
+
*/
|
|
1740
1771
|
window: {
|
|
1741
1772
|
from: string;
|
|
1742
1773
|
to: string;
|
|
1743
1774
|
};
|
|
1775
|
+
/**
|
|
1776
|
+
* The IANA zone this report's local days were bucketed and bounded in. ON THE PAYLOAD, not to be paired with a separate /status call: per-report fetching means /status failing while this one succeeds is a routine outcome, and the window bounds above are UTC instants standing for LOCAL midnights, so reading them in the wrong zone shifts a site east of UTC by a whole day. It is also not guaranteed to equal the `timezone` you asked for — an unusable value falls back to the site's stored zone and then to UTC — so this field, never the request, is what the numbers are in.
|
|
1777
|
+
*/
|
|
1778
|
+
timezone: string;
|
|
1744
1779
|
} | {
|
|
1745
1780
|
status: "unreachable";
|
|
1746
1781
|
};
|
|
@@ -4831,6 +4866,10 @@ type GetBusinessSummaryData = {
|
|
|
4831
4866
|
* Minutes to ADD to UTC for the merchant's local time (browser: -new Date().getTimezoneOffset()). Buckets 'today' and daily series on the merchant's calendar, not UTC's — omit for UTC. Clamped to ±840.
|
|
4832
4867
|
*/
|
|
4833
4868
|
tz_offset_minutes?: string;
|
|
4869
|
+
/**
|
|
4870
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
4871
|
+
*/
|
|
4872
|
+
timezone?: string;
|
|
4834
4873
|
};
|
|
4835
4874
|
url: "/api/v1/summary";
|
|
4836
4875
|
};
|
|
@@ -5036,6 +5075,10 @@ type GetAnalyticsStatusData = {
|
|
|
5036
5075
|
* Required when authenticating with an organization API key — scopes the call to one site in your org. Optional with a site token, and must match that token's site.
|
|
5037
5076
|
*/
|
|
5038
5077
|
site_id?: string;
|
|
5078
|
+
/**
|
|
5079
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5080
|
+
*/
|
|
5081
|
+
timezone?: string;
|
|
5039
5082
|
};
|
|
5040
5083
|
url: "/api/v1/analytics/status";
|
|
5041
5084
|
};
|
|
@@ -5068,6 +5111,10 @@ type GetAnalyticsSummaryData = {
|
|
|
5068
5111
|
* Days covered, ending at the most recent midnight in the site's reporting timezone. Today's partial day is EXCLUDED - including it would compare a complete period against a few hours and read as a traffic collapse every morning. Defaults to 30.
|
|
5069
5112
|
*/
|
|
5070
5113
|
period?: "7" | "30" | "90";
|
|
5114
|
+
/**
|
|
5115
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5116
|
+
*/
|
|
5117
|
+
timezone?: string;
|
|
5071
5118
|
/**
|
|
5072
5119
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5073
5120
|
*/
|
|
@@ -5112,6 +5159,10 @@ type GetAnalyticsTimeseriesData = {
|
|
|
5112
5159
|
* Days covered, ending at the most recent midnight in the site's reporting timezone. Today's partial day is EXCLUDED - including it would compare a complete period against a few hours and read as a traffic collapse every morning. Defaults to 30.
|
|
5113
5160
|
*/
|
|
5114
5161
|
period?: "7" | "30" | "90";
|
|
5162
|
+
/**
|
|
5163
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5164
|
+
*/
|
|
5165
|
+
timezone?: string;
|
|
5115
5166
|
/**
|
|
5116
5167
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5117
5168
|
*/
|
|
@@ -5178,6 +5229,10 @@ type GetAnalyticsSourcesData = {
|
|
|
5178
5229
|
query?: {
|
|
5179
5230
|
site_id?: string;
|
|
5180
5231
|
period?: "7" | "30" | "90";
|
|
5232
|
+
/**
|
|
5233
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5234
|
+
*/
|
|
5235
|
+
timezone?: string;
|
|
5181
5236
|
/**
|
|
5182
5237
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5183
5238
|
*/
|
|
@@ -5218,6 +5273,10 @@ type GetAnalyticsCampaignsData = {
|
|
|
5218
5273
|
query?: {
|
|
5219
5274
|
site_id?: string;
|
|
5220
5275
|
period?: "7" | "30" | "90";
|
|
5276
|
+
/**
|
|
5277
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5278
|
+
*/
|
|
5279
|
+
timezone?: string;
|
|
5221
5280
|
/**
|
|
5222
5281
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5223
5282
|
*/
|
|
@@ -5258,6 +5317,10 @@ type GetAnalyticsUtmMediumData = {
|
|
|
5258
5317
|
query?: {
|
|
5259
5318
|
site_id?: string;
|
|
5260
5319
|
period?: "7" | "30" | "90";
|
|
5320
|
+
/**
|
|
5321
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5322
|
+
*/
|
|
5323
|
+
timezone?: string;
|
|
5261
5324
|
/**
|
|
5262
5325
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5263
5326
|
*/
|
|
@@ -5298,6 +5361,10 @@ type GetAnalyticsUtmSourceData = {
|
|
|
5298
5361
|
query?: {
|
|
5299
5362
|
site_id?: string;
|
|
5300
5363
|
period?: "7" | "30" | "90";
|
|
5364
|
+
/**
|
|
5365
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5366
|
+
*/
|
|
5367
|
+
timezone?: string;
|
|
5301
5368
|
/**
|
|
5302
5369
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5303
5370
|
*/
|
|
@@ -5338,6 +5405,10 @@ type GetAnalyticsUtmCampaignData = {
|
|
|
5338
5405
|
query?: {
|
|
5339
5406
|
site_id?: string;
|
|
5340
5407
|
period?: "7" | "30" | "90";
|
|
5408
|
+
/**
|
|
5409
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5410
|
+
*/
|
|
5411
|
+
timezone?: string;
|
|
5341
5412
|
/**
|
|
5342
5413
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5343
5414
|
*/
|
|
@@ -5378,6 +5449,10 @@ type GetAnalyticsUtmContentData = {
|
|
|
5378
5449
|
query?: {
|
|
5379
5450
|
site_id?: string;
|
|
5380
5451
|
period?: "7" | "30" | "90";
|
|
5452
|
+
/**
|
|
5453
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5454
|
+
*/
|
|
5455
|
+
timezone?: string;
|
|
5381
5456
|
/**
|
|
5382
5457
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5383
5458
|
*/
|
|
@@ -5418,6 +5493,10 @@ type GetAnalyticsUtmTermData = {
|
|
|
5418
5493
|
query?: {
|
|
5419
5494
|
site_id?: string;
|
|
5420
5495
|
period?: "7" | "30" | "90";
|
|
5496
|
+
/**
|
|
5497
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5498
|
+
*/
|
|
5499
|
+
timezone?: string;
|
|
5421
5500
|
/**
|
|
5422
5501
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5423
5502
|
*/
|
|
@@ -5458,6 +5537,10 @@ type GetAnalyticsPagesData = {
|
|
|
5458
5537
|
query?: {
|
|
5459
5538
|
site_id?: string;
|
|
5460
5539
|
period?: "7" | "30" | "90";
|
|
5540
|
+
/**
|
|
5541
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5542
|
+
*/
|
|
5543
|
+
timezone?: string;
|
|
5461
5544
|
/**
|
|
5462
5545
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5463
5546
|
*/
|
|
@@ -5498,6 +5581,10 @@ type GetAnalyticsEntryPagesData = {
|
|
|
5498
5581
|
query?: {
|
|
5499
5582
|
site_id?: string;
|
|
5500
5583
|
period?: "7" | "30" | "90";
|
|
5584
|
+
/**
|
|
5585
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5586
|
+
*/
|
|
5587
|
+
timezone?: string;
|
|
5501
5588
|
/**
|
|
5502
5589
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5503
5590
|
*/
|
|
@@ -5538,6 +5625,10 @@ type GetAnalyticsExitPagesData = {
|
|
|
5538
5625
|
query?: {
|
|
5539
5626
|
site_id?: string;
|
|
5540
5627
|
period?: "7" | "30" | "90";
|
|
5628
|
+
/**
|
|
5629
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5630
|
+
*/
|
|
5631
|
+
timezone?: string;
|
|
5541
5632
|
/**
|
|
5542
5633
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5543
5634
|
*/
|
|
@@ -5578,6 +5669,10 @@ type GetAnalyticsCountriesData = {
|
|
|
5578
5669
|
query?: {
|
|
5579
5670
|
site_id?: string;
|
|
5580
5671
|
period?: "7" | "30" | "90";
|
|
5672
|
+
/**
|
|
5673
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5674
|
+
*/
|
|
5675
|
+
timezone?: string;
|
|
5581
5676
|
/**
|
|
5582
5677
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5583
5678
|
*/
|
|
@@ -5618,6 +5713,10 @@ type GetAnalyticsRegionsData = {
|
|
|
5618
5713
|
query?: {
|
|
5619
5714
|
site_id?: string;
|
|
5620
5715
|
period?: "7" | "30" | "90";
|
|
5716
|
+
/**
|
|
5717
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5718
|
+
*/
|
|
5719
|
+
timezone?: string;
|
|
5621
5720
|
/**
|
|
5622
5721
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5623
5722
|
*/
|
|
@@ -5658,6 +5757,10 @@ type GetAnalyticsCitiesData = {
|
|
|
5658
5757
|
query?: {
|
|
5659
5758
|
site_id?: string;
|
|
5660
5759
|
period?: "7" | "30" | "90";
|
|
5760
|
+
/**
|
|
5761
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5762
|
+
*/
|
|
5763
|
+
timezone?: string;
|
|
5661
5764
|
/**
|
|
5662
5765
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5663
5766
|
*/
|
|
@@ -5698,6 +5801,10 @@ type GetAnalyticsDevicesData = {
|
|
|
5698
5801
|
query?: {
|
|
5699
5802
|
site_id?: string;
|
|
5700
5803
|
period?: "7" | "30" | "90";
|
|
5804
|
+
/**
|
|
5805
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5806
|
+
*/
|
|
5807
|
+
timezone?: string;
|
|
5701
5808
|
/**
|
|
5702
5809
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5703
5810
|
*/
|
|
@@ -5738,6 +5845,10 @@ type GetAnalyticsBrowsersData = {
|
|
|
5738
5845
|
query?: {
|
|
5739
5846
|
site_id?: string;
|
|
5740
5847
|
period?: "7" | "30" | "90";
|
|
5848
|
+
/**
|
|
5849
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5850
|
+
*/
|
|
5851
|
+
timezone?: string;
|
|
5741
5852
|
/**
|
|
5742
5853
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5743
5854
|
*/
|
|
@@ -5778,6 +5889,10 @@ type GetAnalyticsOperatingSystemsData = {
|
|
|
5778
5889
|
query?: {
|
|
5779
5890
|
site_id?: string;
|
|
5780
5891
|
period?: "7" | "30" | "90";
|
|
5892
|
+
/**
|
|
5893
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5894
|
+
*/
|
|
5895
|
+
timezone?: string;
|
|
5781
5896
|
/**
|
|
5782
5897
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5783
5898
|
*/
|
|
@@ -5818,6 +5933,10 @@ type GetAnalyticsChannelsData = {
|
|
|
5818
5933
|
query?: {
|
|
5819
5934
|
site_id?: string;
|
|
5820
5935
|
period?: "7" | "30" | "90";
|
|
5936
|
+
/**
|
|
5937
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5938
|
+
*/
|
|
5939
|
+
timezone?: string;
|
|
5821
5940
|
/**
|
|
5822
5941
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5823
5942
|
*/
|
|
@@ -5863,6 +5982,10 @@ type GetAnalyticsGoalTargetsData = {
|
|
|
5863
5982
|
* Days covered, ending at the most recent midnight in the site's reporting timezone. Today's partial day is EXCLUDED - including it would compare a complete period against a few hours and read as a traffic collapse every morning. Defaults to 30.
|
|
5864
5983
|
*/
|
|
5865
5984
|
period?: "7" | "30" | "90";
|
|
5985
|
+
/**
|
|
5986
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
5987
|
+
*/
|
|
5988
|
+
timezone?: string;
|
|
5866
5989
|
/**
|
|
5867
5990
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5868
5991
|
*/
|
|
@@ -5930,6 +6053,10 @@ type GetAnalyticsGoalTargetsResponses = {
|
|
|
5930
6053
|
from: string;
|
|
5931
6054
|
to: string;
|
|
5932
6055
|
};
|
|
6056
|
+
/**
|
|
6057
|
+
* The IANA zone this report's local days were bucketed and bounded in. ON THE PAYLOAD, not to be paired with a separate /status call: per-report fetching means /status failing while this one succeeds is a routine outcome, and the window bounds above are UTC instants standing for LOCAL midnights, so reading them in the wrong zone shifts a site east of UTC by a whole day. It is also not guaranteed to equal the `timezone` you asked for — an unusable value falls back to the site's stored zone and then to UTC — so this field, never the request, is what the numbers are in.
|
|
6058
|
+
*/
|
|
6059
|
+
timezone: string;
|
|
5933
6060
|
/**
|
|
5934
6061
|
* The goal these values belong to, echoed back so a client can label the table without trusting its own request.
|
|
5935
6062
|
*/
|
|
@@ -5976,6 +6103,10 @@ type GetAnalyticsConversionsData = {
|
|
|
5976
6103
|
* Days covered, ending at the most recent midnight in the site's reporting timezone. Today's partial day is EXCLUDED - including it would compare a complete period against a few hours and read as a traffic collapse every morning. Defaults to 30.
|
|
5977
6104
|
*/
|
|
5978
6105
|
period?: "7" | "30" | "90";
|
|
6106
|
+
/**
|
|
6107
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
6108
|
+
*/
|
|
6109
|
+
timezone?: string;
|
|
5979
6110
|
/**
|
|
5980
6111
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5981
6112
|
*/
|
|
@@ -6043,6 +6174,10 @@ type GetAnalyticsConversionsResponses = {
|
|
|
6043
6174
|
from: string;
|
|
6044
6175
|
to: string;
|
|
6045
6176
|
};
|
|
6177
|
+
/**
|
|
6178
|
+
* The IANA zone this report's local days were bucketed and bounded in. ON THE PAYLOAD, not to be paired with a separate /status call: per-report fetching means /status failing while this one succeeds is a routine outcome, and the window bounds above are UTC instants standing for LOCAL midnights, so reading them in the wrong zone shifts a site east of UTC by a whole day. It is also not guaranteed to equal the `timezone` you asked for — an unusable value falls back to the site's stored zone and then to UTC — so this field, never the request, is what the numbers are in.
|
|
6179
|
+
*/
|
|
6180
|
+
timezone: string;
|
|
6046
6181
|
/**
|
|
6047
6182
|
* Site-wide unique visitors for the window, with no goal filtering — the denominator every `conversion_rate` above divides by. Say what the rate is a ratio of wherever you show one: this is Plausible's definition and it surprises people, because the rates do not sum to 100%.
|
|
6048
6183
|
*/
|
|
@@ -6072,6 +6207,10 @@ type GetAnalyticsFunnelReportData = {
|
|
|
6072
6207
|
query?: {
|
|
6073
6208
|
site_id?: string;
|
|
6074
6209
|
period?: "7" | "30" | "90";
|
|
6210
|
+
/**
|
|
6211
|
+
* IANA zone name to bucket this report's local days in, e.g. `America/Denver`. Takes precedence over the site's stored reporting timezone; an unrecognised value falls back to that stored zone and then to UTC rather than failing, because a report is more useful in the wrong zone than not at all. Affects where every day boundary falls, so two requests differing only in this parameter are different answers and are cached separately. READ THE RESPONSE'S OWN `timezone` rather than assuming it echoes this parameter: an unrecognised value is answered in the site's stored zone, not refused.
|
|
6212
|
+
*/
|
|
6213
|
+
timezone?: string;
|
|
6075
6214
|
/**
|
|
6076
6215
|
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
6077
6216
|
*/
|
|
@@ -6139,6 +6278,10 @@ type GetAnalyticsFunnelReportResponses = {
|
|
|
6139
6278
|
from: string;
|
|
6140
6279
|
to: string;
|
|
6141
6280
|
};
|
|
6281
|
+
/**
|
|
6282
|
+
* The IANA zone this report's local days were bucketed and bounded in. ON THE PAYLOAD, not to be paired with a separate /status call: per-report fetching means /status failing while this one succeeds is a routine outcome, and the window bounds above are UTC instants standing for LOCAL midnights, so reading them in the wrong zone shifts a site east of UTC by a whole day. It is also not guaranteed to equal the `timezone` you asked for — an unusable value falls back to the site's stored zone and then to UTC — so this field, never the request, is what the numbers are in.
|
|
6283
|
+
*/
|
|
6284
|
+
timezone: string;
|
|
6142
6285
|
funnel: {
|
|
6143
6286
|
id: string;
|
|
6144
6287
|
display_name: string;
|
|
@@ -11138,7 +11281,7 @@ declare const setOrderFulfillment: <ThrowOnError extends boolean = false>(option
|
|
|
11138
11281
|
/**
|
|
11139
11282
|
* Collection status for a site (site token, or org key with site_id)
|
|
11140
11283
|
*
|
|
11141
|
-
* Whether this site can collect at all, the zone its reports are bucketed in, and when it first recorded anything. Ask this before rendering an empty panel: it separates 'not collecting' (no analytics identity - nothing will ever arrive) from 'collecting, no traffic yet', which need different things said to the merchant.
|
|
11284
|
+
* Whether this site can collect at all, the zone its reports are bucketed in, and when it first recorded anything. Ask this before rendering an empty panel: it separates 'not collecting' (no analytics identity - nothing will ever arrive) from 'collecting, no traffic yet', which need different things said to the merchant. SEND THE SAME `timezone` you send to the reports: this endpoint answers `timezone_defaulted` and compares `first_seen` against local day boundaries, so resolving it in a different zone than the reports makes it answer about days the reports are not describing.
|
|
11142
11285
|
*/
|
|
11143
11286
|
declare const getAnalyticsStatus: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsStatusData, ThrowOnError>) => RequestResult<GetAnalyticsStatusResponses, GetAnalyticsStatusErrors, ThrowOnError, "fields">;
|
|
11144
11287
|
/**
|