@aifeatures/backend 0.10.0 → 0.11.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 +234 -18
- package/dist/index.d.ts +234 -18
- package/package.json +9 -8
package/dist/index.d.cts
CHANGED
|
@@ -4900,6 +4900,14 @@ type GetAnalyticsSummaryData = {
|
|
|
4900
4900
|
* 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.
|
|
4901
4901
|
*/
|
|
4902
4902
|
period?: "7" | "30" | "90";
|
|
4903
|
+
/**
|
|
4904
|
+
* 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.
|
|
4905
|
+
*/
|
|
4906
|
+
from?: string;
|
|
4907
|
+
/**
|
|
4908
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
4909
|
+
*/
|
|
4910
|
+
to?: string;
|
|
4903
4911
|
/**
|
|
4904
4912
|
* Drill-down filters as a JSON array, ANDed with each other: [{"dimension":"page","operator":"is","values":["/pricing"]}]. `operator` is `is` or `is_not` and defaults to `is`; `values` are ORed within one filter. At most 3 filters, 100 values each. JSON rather than a delimited string because the values are merchant data - URLs with commas, campaign names with equals signs - and every delimiter worth choosing appears inside some legitimate value. Dimensions: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term, channel. `channel` is not a stored column: it is resolved against the window's real acquisition tuples using the same classifier the Channels card uses, so clicking a channel row cannot select a different set than that row claimed. THE SAME FILTERS MUST BE SENT TO EVERY REPORT ON A PAGE - a filtered chart beside an unfiltered tile is worse than no filtering, because the tiles are the numbers a merchant quotes.
|
|
4905
4913
|
*/
|
|
@@ -4936,6 +4944,14 @@ type GetAnalyticsTimeseriesData = {
|
|
|
4936
4944
|
* 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.
|
|
4937
4945
|
*/
|
|
4938
4946
|
period?: "7" | "30" | "90";
|
|
4947
|
+
/**
|
|
4948
|
+
* 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.
|
|
4949
|
+
*/
|
|
4950
|
+
from?: string;
|
|
4951
|
+
/**
|
|
4952
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
4953
|
+
*/
|
|
4954
|
+
to?: string;
|
|
4939
4955
|
/**
|
|
4940
4956
|
* Drill-down filters as a JSON array, ANDed with each other: [{"dimension":"page","operator":"is","values":["/pricing"]}]. `operator` is `is` or `is_not` and defaults to `is`; `values` are ORed within one filter. At most 3 filters, 100 values each. JSON rather than a delimited string because the values are merchant data - URLs with commas, campaign names with equals signs - and every delimiter worth choosing appears inside some legitimate value. Dimensions: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term, channel. `channel` is not a stored column: it is resolved against the window's real acquisition tuples using the same classifier the Channels card uses, so clicking a channel row cannot select a different set than that row claimed. THE SAME FILTERS MUST BE SENT TO EVERY REPORT ON A PAGE - a filtered chart beside an unfiltered tile is worse than no filtering, because the tiles are the numbers a merchant quotes.
|
|
4941
4957
|
*/
|
|
@@ -4994,8 +5010,20 @@ type GetAnalyticsSourcesData = {
|
|
|
4994
5010
|
query?: {
|
|
4995
5011
|
site_id?: string;
|
|
4996
5012
|
period?: "7" | "30" | "90";
|
|
5013
|
+
/**
|
|
5014
|
+
* 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.
|
|
5015
|
+
*/
|
|
5016
|
+
from?: string;
|
|
5017
|
+
/**
|
|
5018
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5019
|
+
*/
|
|
5020
|
+
to?: string;
|
|
4997
5021
|
limit?: string;
|
|
4998
5022
|
filters?: string;
|
|
5023
|
+
/**
|
|
5024
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5025
|
+
*/
|
|
5026
|
+
dimension2?: string;
|
|
4999
5027
|
};
|
|
5000
5028
|
url: "/api/v1/analytics/sources";
|
|
5001
5029
|
};
|
|
@@ -5022,8 +5050,20 @@ type GetAnalyticsCampaignsData = {
|
|
|
5022
5050
|
query?: {
|
|
5023
5051
|
site_id?: string;
|
|
5024
5052
|
period?: "7" | "30" | "90";
|
|
5053
|
+
/**
|
|
5054
|
+
* 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.
|
|
5055
|
+
*/
|
|
5056
|
+
from?: string;
|
|
5057
|
+
/**
|
|
5058
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5059
|
+
*/
|
|
5060
|
+
to?: string;
|
|
5025
5061
|
limit?: string;
|
|
5026
5062
|
filters?: string;
|
|
5063
|
+
/**
|
|
5064
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5065
|
+
*/
|
|
5066
|
+
dimension2?: string;
|
|
5027
5067
|
};
|
|
5028
5068
|
url: "/api/v1/analytics/campaigns";
|
|
5029
5069
|
};
|
|
@@ -5050,8 +5090,20 @@ type GetAnalyticsUtmMediumData = {
|
|
|
5050
5090
|
query?: {
|
|
5051
5091
|
site_id?: string;
|
|
5052
5092
|
period?: "7" | "30" | "90";
|
|
5093
|
+
/**
|
|
5094
|
+
* 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.
|
|
5095
|
+
*/
|
|
5096
|
+
from?: string;
|
|
5097
|
+
/**
|
|
5098
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5099
|
+
*/
|
|
5100
|
+
to?: string;
|
|
5053
5101
|
limit?: string;
|
|
5054
5102
|
filters?: string;
|
|
5103
|
+
/**
|
|
5104
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5105
|
+
*/
|
|
5106
|
+
dimension2?: string;
|
|
5055
5107
|
};
|
|
5056
5108
|
url: "/api/v1/analytics/utm/medium";
|
|
5057
5109
|
};
|
|
@@ -5078,8 +5130,20 @@ type GetAnalyticsUtmSourceData = {
|
|
|
5078
5130
|
query?: {
|
|
5079
5131
|
site_id?: string;
|
|
5080
5132
|
period?: "7" | "30" | "90";
|
|
5133
|
+
/**
|
|
5134
|
+
* 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.
|
|
5135
|
+
*/
|
|
5136
|
+
from?: string;
|
|
5137
|
+
/**
|
|
5138
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5139
|
+
*/
|
|
5140
|
+
to?: string;
|
|
5081
5141
|
limit?: string;
|
|
5082
5142
|
filters?: string;
|
|
5143
|
+
/**
|
|
5144
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5145
|
+
*/
|
|
5146
|
+
dimension2?: string;
|
|
5083
5147
|
};
|
|
5084
5148
|
url: "/api/v1/analytics/utm/source";
|
|
5085
5149
|
};
|
|
@@ -5106,8 +5170,20 @@ type GetAnalyticsUtmCampaignData = {
|
|
|
5106
5170
|
query?: {
|
|
5107
5171
|
site_id?: string;
|
|
5108
5172
|
period?: "7" | "30" | "90";
|
|
5173
|
+
/**
|
|
5174
|
+
* 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.
|
|
5175
|
+
*/
|
|
5176
|
+
from?: string;
|
|
5177
|
+
/**
|
|
5178
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5179
|
+
*/
|
|
5180
|
+
to?: string;
|
|
5109
5181
|
limit?: string;
|
|
5110
5182
|
filters?: string;
|
|
5183
|
+
/**
|
|
5184
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5185
|
+
*/
|
|
5186
|
+
dimension2?: string;
|
|
5111
5187
|
};
|
|
5112
5188
|
url: "/api/v1/analytics/utm/campaign";
|
|
5113
5189
|
};
|
|
@@ -5134,8 +5210,20 @@ type GetAnalyticsUtmContentData = {
|
|
|
5134
5210
|
query?: {
|
|
5135
5211
|
site_id?: string;
|
|
5136
5212
|
period?: "7" | "30" | "90";
|
|
5213
|
+
/**
|
|
5214
|
+
* 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.
|
|
5215
|
+
*/
|
|
5216
|
+
from?: string;
|
|
5217
|
+
/**
|
|
5218
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5219
|
+
*/
|
|
5220
|
+
to?: string;
|
|
5137
5221
|
limit?: string;
|
|
5138
5222
|
filters?: string;
|
|
5223
|
+
/**
|
|
5224
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5225
|
+
*/
|
|
5226
|
+
dimension2?: string;
|
|
5139
5227
|
};
|
|
5140
5228
|
url: "/api/v1/analytics/utm/content";
|
|
5141
5229
|
};
|
|
@@ -5162,8 +5250,20 @@ type GetAnalyticsUtmTermData = {
|
|
|
5162
5250
|
query?: {
|
|
5163
5251
|
site_id?: string;
|
|
5164
5252
|
period?: "7" | "30" | "90";
|
|
5253
|
+
/**
|
|
5254
|
+
* 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.
|
|
5255
|
+
*/
|
|
5256
|
+
from?: string;
|
|
5257
|
+
/**
|
|
5258
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5259
|
+
*/
|
|
5260
|
+
to?: string;
|
|
5165
5261
|
limit?: string;
|
|
5166
5262
|
filters?: string;
|
|
5263
|
+
/**
|
|
5264
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5265
|
+
*/
|
|
5266
|
+
dimension2?: string;
|
|
5167
5267
|
};
|
|
5168
5268
|
url: "/api/v1/analytics/utm/term";
|
|
5169
5269
|
};
|
|
@@ -5190,8 +5290,20 @@ type GetAnalyticsPagesData = {
|
|
|
5190
5290
|
query?: {
|
|
5191
5291
|
site_id?: string;
|
|
5192
5292
|
period?: "7" | "30" | "90";
|
|
5293
|
+
/**
|
|
5294
|
+
* 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.
|
|
5295
|
+
*/
|
|
5296
|
+
from?: string;
|
|
5297
|
+
/**
|
|
5298
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5299
|
+
*/
|
|
5300
|
+
to?: string;
|
|
5193
5301
|
limit?: string;
|
|
5194
5302
|
filters?: string;
|
|
5303
|
+
/**
|
|
5304
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5305
|
+
*/
|
|
5306
|
+
dimension2?: string;
|
|
5195
5307
|
};
|
|
5196
5308
|
url: "/api/v1/analytics/pages";
|
|
5197
5309
|
};
|
|
@@ -5218,8 +5330,20 @@ type GetAnalyticsEntryPagesData = {
|
|
|
5218
5330
|
query?: {
|
|
5219
5331
|
site_id?: string;
|
|
5220
5332
|
period?: "7" | "30" | "90";
|
|
5333
|
+
/**
|
|
5334
|
+
* 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.
|
|
5335
|
+
*/
|
|
5336
|
+
from?: string;
|
|
5337
|
+
/**
|
|
5338
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5339
|
+
*/
|
|
5340
|
+
to?: string;
|
|
5221
5341
|
limit?: string;
|
|
5222
5342
|
filters?: string;
|
|
5343
|
+
/**
|
|
5344
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5345
|
+
*/
|
|
5346
|
+
dimension2?: string;
|
|
5223
5347
|
};
|
|
5224
5348
|
url: "/api/v1/analytics/entry-pages";
|
|
5225
5349
|
};
|
|
@@ -5246,8 +5370,20 @@ type GetAnalyticsExitPagesData = {
|
|
|
5246
5370
|
query?: {
|
|
5247
5371
|
site_id?: string;
|
|
5248
5372
|
period?: "7" | "30" | "90";
|
|
5373
|
+
/**
|
|
5374
|
+
* 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.
|
|
5375
|
+
*/
|
|
5376
|
+
from?: string;
|
|
5377
|
+
/**
|
|
5378
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5379
|
+
*/
|
|
5380
|
+
to?: string;
|
|
5249
5381
|
limit?: string;
|
|
5250
5382
|
filters?: string;
|
|
5383
|
+
/**
|
|
5384
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5385
|
+
*/
|
|
5386
|
+
dimension2?: string;
|
|
5251
5387
|
};
|
|
5252
5388
|
url: "/api/v1/analytics/exit-pages";
|
|
5253
5389
|
};
|
|
@@ -5274,8 +5410,20 @@ type GetAnalyticsCountriesData = {
|
|
|
5274
5410
|
query?: {
|
|
5275
5411
|
site_id?: string;
|
|
5276
5412
|
period?: "7" | "30" | "90";
|
|
5413
|
+
/**
|
|
5414
|
+
* 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.
|
|
5415
|
+
*/
|
|
5416
|
+
from?: string;
|
|
5417
|
+
/**
|
|
5418
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5419
|
+
*/
|
|
5420
|
+
to?: string;
|
|
5277
5421
|
limit?: string;
|
|
5278
5422
|
filters?: string;
|
|
5423
|
+
/**
|
|
5424
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5425
|
+
*/
|
|
5426
|
+
dimension2?: string;
|
|
5279
5427
|
};
|
|
5280
5428
|
url: "/api/v1/analytics/countries";
|
|
5281
5429
|
};
|
|
@@ -5302,8 +5450,20 @@ type GetAnalyticsRegionsData = {
|
|
|
5302
5450
|
query?: {
|
|
5303
5451
|
site_id?: string;
|
|
5304
5452
|
period?: "7" | "30" | "90";
|
|
5453
|
+
/**
|
|
5454
|
+
* 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.
|
|
5455
|
+
*/
|
|
5456
|
+
from?: string;
|
|
5457
|
+
/**
|
|
5458
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5459
|
+
*/
|
|
5460
|
+
to?: string;
|
|
5305
5461
|
limit?: string;
|
|
5306
5462
|
filters?: string;
|
|
5463
|
+
/**
|
|
5464
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5465
|
+
*/
|
|
5466
|
+
dimension2?: string;
|
|
5307
5467
|
};
|
|
5308
5468
|
url: "/api/v1/analytics/regions";
|
|
5309
5469
|
};
|
|
@@ -5330,8 +5490,20 @@ type GetAnalyticsCitiesData = {
|
|
|
5330
5490
|
query?: {
|
|
5331
5491
|
site_id?: string;
|
|
5332
5492
|
period?: "7" | "30" | "90";
|
|
5493
|
+
/**
|
|
5494
|
+
* 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.
|
|
5495
|
+
*/
|
|
5496
|
+
from?: string;
|
|
5497
|
+
/**
|
|
5498
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5499
|
+
*/
|
|
5500
|
+
to?: string;
|
|
5333
5501
|
limit?: string;
|
|
5334
5502
|
filters?: string;
|
|
5503
|
+
/**
|
|
5504
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5505
|
+
*/
|
|
5506
|
+
dimension2?: string;
|
|
5335
5507
|
};
|
|
5336
5508
|
url: "/api/v1/analytics/cities";
|
|
5337
5509
|
};
|
|
@@ -5358,8 +5530,20 @@ type GetAnalyticsDevicesData = {
|
|
|
5358
5530
|
query?: {
|
|
5359
5531
|
site_id?: string;
|
|
5360
5532
|
period?: "7" | "30" | "90";
|
|
5533
|
+
/**
|
|
5534
|
+
* 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.
|
|
5535
|
+
*/
|
|
5536
|
+
from?: string;
|
|
5537
|
+
/**
|
|
5538
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5539
|
+
*/
|
|
5540
|
+
to?: string;
|
|
5361
5541
|
limit?: string;
|
|
5362
5542
|
filters?: string;
|
|
5543
|
+
/**
|
|
5544
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5545
|
+
*/
|
|
5546
|
+
dimension2?: string;
|
|
5363
5547
|
};
|
|
5364
5548
|
url: "/api/v1/analytics/devices";
|
|
5365
5549
|
};
|
|
@@ -5386,8 +5570,20 @@ type GetAnalyticsBrowsersData = {
|
|
|
5386
5570
|
query?: {
|
|
5387
5571
|
site_id?: string;
|
|
5388
5572
|
period?: "7" | "30" | "90";
|
|
5573
|
+
/**
|
|
5574
|
+
* 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.
|
|
5575
|
+
*/
|
|
5576
|
+
from?: string;
|
|
5577
|
+
/**
|
|
5578
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5579
|
+
*/
|
|
5580
|
+
to?: string;
|
|
5389
5581
|
limit?: string;
|
|
5390
5582
|
filters?: string;
|
|
5583
|
+
/**
|
|
5584
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5585
|
+
*/
|
|
5586
|
+
dimension2?: string;
|
|
5391
5587
|
};
|
|
5392
5588
|
url: "/api/v1/analytics/browsers";
|
|
5393
5589
|
};
|
|
@@ -5414,8 +5610,20 @@ type GetAnalyticsOperatingSystemsData = {
|
|
|
5414
5610
|
query?: {
|
|
5415
5611
|
site_id?: string;
|
|
5416
5612
|
period?: "7" | "30" | "90";
|
|
5613
|
+
/**
|
|
5614
|
+
* 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.
|
|
5615
|
+
*/
|
|
5616
|
+
from?: string;
|
|
5617
|
+
/**
|
|
5618
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5619
|
+
*/
|
|
5620
|
+
to?: string;
|
|
5417
5621
|
limit?: string;
|
|
5418
5622
|
filters?: string;
|
|
5623
|
+
/**
|
|
5624
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5625
|
+
*/
|
|
5626
|
+
dimension2?: string;
|
|
5419
5627
|
};
|
|
5420
5628
|
url: "/api/v1/analytics/operating-systems";
|
|
5421
5629
|
};
|
|
@@ -5442,6 +5650,14 @@ type GetAnalyticsChannelsData = {
|
|
|
5442
5650
|
query?: {
|
|
5443
5651
|
site_id?: string;
|
|
5444
5652
|
period?: "7" | "30" | "90";
|
|
5653
|
+
/**
|
|
5654
|
+
* 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.
|
|
5655
|
+
*/
|
|
5656
|
+
from?: string;
|
|
5657
|
+
/**
|
|
5658
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5659
|
+
*/
|
|
5660
|
+
to?: string;
|
|
5445
5661
|
filters?: string;
|
|
5446
5662
|
};
|
|
5447
5663
|
url: "/api/v1/analytics/channels";
|
|
@@ -9787,13 +10003,13 @@ declare const getAnalyticsStatus: <ThrowOnError extends boolean = false>(options
|
|
|
9787
10003
|
/**
|
|
9788
10004
|
* Top-line metrics with period-over-period comparison
|
|
9789
10005
|
*
|
|
9790
|
-
* Visitors, visits, pageviews, views per visit, bounce rate and mean visit duration for the period, plus the immediately preceding same-length window for deltas. `previous` is null when that window is not fully covered by collection. Note the two scopings: visits, bounce rate and duration describe visits that STARTED in the window; pageviews and visitors count events INSIDE it, which is what keeps this tile agreeing with the chart beside it.
|
|
10006
|
+
* Visitors, visits, pageviews, views per visit, bounce rate and mean visit duration for the period, plus the immediately preceding same-length window for deltas. `previous` is null when that window is not fully covered by collection. Note the two scopings: visits, bounce rate and duration describe visits that STARTED in the window; pageviews and visitors count events INSIDE it, which is what keeps this tile agreeing with the chart beside it. Use `from`/`to` in place of `period` for an explicit range; the comparison is then the same number of days immediately before it.
|
|
9791
10007
|
*/
|
|
9792
10008
|
declare const getAnalyticsSummary: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsSummaryData, ThrowOnError>) => RequestResult<GetAnalyticsSummaryResponses, GetAnalyticsSummaryErrors, ThrowOnError, "fields">;
|
|
9793
10009
|
/**
|
|
9794
10010
|
* Visitors by day for the period
|
|
9795
10011
|
*
|
|
9796
|
-
* One row per local day with traffic, bucketed in the site's reporting timezone. Days with no traffic are omitted rather than zero-filled.
|
|
10012
|
+
* One row per local day with traffic, bucketed in the site's reporting timezone. Days with no traffic are omitted rather than zero-filled. Use `from`/`to` in place of `period` for an explicit range. Day is the only bucket size: sub-day and multi-day buckets would need a pipe change, not a parameter.
|
|
9797
10013
|
*/
|
|
9798
10014
|
declare const getAnalyticsTimeseries: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsTimeseriesData, ThrowOnError>) => RequestResult<GetAnalyticsTimeseriesResponses, GetAnalyticsTimeseriesErrors, ThrowOnError, "fields">;
|
|
9799
10015
|
/**
|
|
@@ -9805,97 +10021,97 @@ declare const getAnalyticsRealtime: <ThrowOnError extends boolean = false>(optio
|
|
|
9805
10021
|
/**
|
|
9806
10022
|
* source breakdown for the period
|
|
9807
10023
|
*
|
|
9808
|
-
* Ranked source rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10024
|
+
* Ranked source rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. This report rejects `dimension2` whatever is asked for: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. Ask for the other report crossed the other way up instead. The 400 names the alternative for the dimension asked for.
|
|
9809
10025
|
*/
|
|
9810
10026
|
declare const getAnalyticsSources: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsSourcesData, ThrowOnError>) => RequestResult<GetAnalyticsSourcesResponses, GetAnalyticsSourcesErrors, ThrowOnError, "fields">;
|
|
9811
10027
|
/**
|
|
9812
10028
|
* campaign breakdown for the period
|
|
9813
10029
|
*
|
|
9814
|
-
* Ranked campaign rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10030
|
+
* Ranked campaign rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (visits) — crossing never changes what the count means.
|
|
9815
10031
|
*/
|
|
9816
10032
|
declare const getAnalyticsCampaigns: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsCampaignsData, ThrowOnError>) => RequestResult<GetAnalyticsCampaignsResponses, GetAnalyticsCampaignsErrors, ThrowOnError, "fields">;
|
|
9817
10033
|
/**
|
|
9818
10034
|
* utm_medium breakdown for the period
|
|
9819
10035
|
*
|
|
9820
|
-
* Ranked utm_medium rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10036
|
+
* Ranked utm_medium rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (visits) — crossing never changes what the count means.
|
|
9821
10037
|
*/
|
|
9822
10038
|
declare const getAnalyticsUtmMedium: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmMediumData, ThrowOnError>) => RequestResult<GetAnalyticsUtmMediumResponses, GetAnalyticsUtmMediumErrors, ThrowOnError, "fields">;
|
|
9823
10039
|
/**
|
|
9824
10040
|
* utm_source breakdown for the period
|
|
9825
10041
|
*
|
|
9826
|
-
* Ranked utm_source rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10042
|
+
* Ranked utm_source rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (visits) — crossing never changes what the count means.
|
|
9827
10043
|
*/
|
|
9828
10044
|
declare const getAnalyticsUtmSource: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmSourceData, ThrowOnError>) => RequestResult<GetAnalyticsUtmSourceResponses, GetAnalyticsUtmSourceErrors, ThrowOnError, "fields">;
|
|
9829
10045
|
/**
|
|
9830
10046
|
* campaign breakdown for the period
|
|
9831
10047
|
*
|
|
9832
|
-
* Ranked campaign rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10048
|
+
* Ranked campaign rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (visits) — crossing never changes what the count means.
|
|
9833
10049
|
*/
|
|
9834
10050
|
declare const getAnalyticsUtmCampaign: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmCampaignData, ThrowOnError>) => RequestResult<GetAnalyticsUtmCampaignResponses, GetAnalyticsUtmCampaignErrors, ThrowOnError, "fields">;
|
|
9835
10051
|
/**
|
|
9836
10052
|
* utm_content breakdown for the period
|
|
9837
10053
|
*
|
|
9838
|
-
* Ranked utm_content rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10054
|
+
* Ranked utm_content rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (visits) — crossing never changes what the count means.
|
|
9839
10055
|
*/
|
|
9840
10056
|
declare const getAnalyticsUtmContent: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmContentData, ThrowOnError>) => RequestResult<GetAnalyticsUtmContentResponses, GetAnalyticsUtmContentErrors, ThrowOnError, "fields">;
|
|
9841
10057
|
/**
|
|
9842
10058
|
* utm_term breakdown for the period
|
|
9843
10059
|
*
|
|
9844
|
-
* Ranked utm_term rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10060
|
+
* Ranked utm_term rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (visits) — crossing never changes what the count means.
|
|
9845
10061
|
*/
|
|
9846
10062
|
declare const getAnalyticsUtmTerm: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmTermData, ThrowOnError>) => RequestResult<GetAnalyticsUtmTermResponses, GetAnalyticsUtmTermErrors, ThrowOnError, "fields">;
|
|
9847
10063
|
/**
|
|
9848
10064
|
* pathname breakdown for the period
|
|
9849
10065
|
*
|
|
9850
|
-
* Ranked pathname rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10066
|
+
* Ranked pathname rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (pageviews) — crossing never changes what the count means.
|
|
9851
10067
|
*/
|
|
9852
10068
|
declare const getAnalyticsPages: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsPagesData, ThrowOnError>) => RequestResult<GetAnalyticsPagesResponses, GetAnalyticsPagesErrors, ThrowOnError, "fields">;
|
|
9853
10069
|
/**
|
|
9854
10070
|
* pathname breakdown for the period
|
|
9855
10071
|
*
|
|
9856
|
-
* Ranked pathname rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10072
|
+
* Ranked pathname rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (entries) — crossing never changes what the count means.
|
|
9857
10073
|
*/
|
|
9858
10074
|
declare const getAnalyticsEntryPages: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsEntryPagesData, ThrowOnError>) => RequestResult<GetAnalyticsEntryPagesResponses, GetAnalyticsEntryPagesErrors, ThrowOnError, "fields">;
|
|
9859
10075
|
/**
|
|
9860
10076
|
* pathname breakdown for the period
|
|
9861
10077
|
*
|
|
9862
|
-
* Ranked pathname rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10078
|
+
* Ranked pathname rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (exits) — crossing never changes what the count means.
|
|
9863
10079
|
*/
|
|
9864
10080
|
declare const getAnalyticsExitPages: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsExitPagesData, ThrowOnError>) => RequestResult<GetAnalyticsExitPagesResponses, GetAnalyticsExitPagesErrors, ThrowOnError, "fields">;
|
|
9865
10081
|
/**
|
|
9866
10082
|
* country breakdown for the period
|
|
9867
10083
|
*
|
|
9868
|
-
* Ranked country rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10084
|
+
* Ranked country rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (pageviews) — crossing never changes what the count means.
|
|
9869
10085
|
*/
|
|
9870
10086
|
declare const getAnalyticsCountries: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsCountriesData, ThrowOnError>) => RequestResult<GetAnalyticsCountriesResponses, GetAnalyticsCountriesErrors, ThrowOnError, "fields">;
|
|
9871
10087
|
/**
|
|
9872
10088
|
* region breakdown for the period
|
|
9873
10089
|
*
|
|
9874
|
-
* Ranked region rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10090
|
+
* Ranked region rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. This report rejects `dimension2` whatever is asked for: it already spends the pipe's one second slot on country, without which its values cannot be told apart. Ask for the other report crossed the other way up instead. The 400 names the alternative for the dimension asked for.
|
|
9875
10091
|
*/
|
|
9876
10092
|
declare const getAnalyticsRegions: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsRegionsData, ThrowOnError>) => RequestResult<GetAnalyticsRegionsResponses, GetAnalyticsRegionsErrors, ThrowOnError, "fields">;
|
|
9877
10093
|
/**
|
|
9878
10094
|
* city breakdown for the period
|
|
9879
10095
|
*
|
|
9880
|
-
* Ranked city rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10096
|
+
* Ranked city rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. This report rejects `dimension2` whatever is asked for: it already spends the pipe's one second slot on country, without which its values cannot be told apart. Ask for the other report crossed the other way up instead. The 400 names the alternative for the dimension asked for.
|
|
9881
10097
|
*/
|
|
9882
10098
|
declare const getAnalyticsCities: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsCitiesData, ThrowOnError>) => RequestResult<GetAnalyticsCitiesResponses, GetAnalyticsCitiesErrors, ThrowOnError, "fields">;
|
|
9883
10099
|
/**
|
|
9884
10100
|
* device breakdown for the period
|
|
9885
10101
|
*
|
|
9886
|
-
* Ranked device rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10102
|
+
* Ranked device rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (pageviews) — crossing never changes what the count means.
|
|
9887
10103
|
*/
|
|
9888
10104
|
declare const getAnalyticsDevices: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsDevicesData, ThrowOnError>) => RequestResult<GetAnalyticsDevicesResponses, GetAnalyticsDevicesErrors, ThrowOnError, "fields">;
|
|
9889
10105
|
/**
|
|
9890
10106
|
* browser breakdown for the period
|
|
9891
10107
|
*
|
|
9892
|
-
* Ranked browser rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10108
|
+
* Ranked browser rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (pageviews) — crossing never changes what the count means.
|
|
9893
10109
|
*/
|
|
9894
10110
|
declare const getAnalyticsBrowsers: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsBrowsersData, ThrowOnError>) => RequestResult<GetAnalyticsBrowsersResponses, GetAnalyticsBrowsersErrors, ThrowOnError, "fields">;
|
|
9895
10111
|
/**
|
|
9896
10112
|
* os breakdown for the period
|
|
9897
10113
|
*
|
|
9898
|
-
* Ranked os rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10114
|
+
* Ranked os rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (pageviews) — crossing never changes what the count means.
|
|
9899
10115
|
*/
|
|
9900
10116
|
declare const getAnalyticsOperatingSystems: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsOperatingSystemsData, ThrowOnError>) => RequestResult<GetAnalyticsOperatingSystemsResponses, GetAnalyticsOperatingSystemsErrors, ThrowOnError, "fields">;
|
|
9901
10117
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -4900,6 +4900,14 @@ type GetAnalyticsSummaryData = {
|
|
|
4900
4900
|
* 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.
|
|
4901
4901
|
*/
|
|
4902
4902
|
period?: "7" | "30" | "90";
|
|
4903
|
+
/**
|
|
4904
|
+
* 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.
|
|
4905
|
+
*/
|
|
4906
|
+
from?: string;
|
|
4907
|
+
/**
|
|
4908
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
4909
|
+
*/
|
|
4910
|
+
to?: string;
|
|
4903
4911
|
/**
|
|
4904
4912
|
* Drill-down filters as a JSON array, ANDed with each other: [{"dimension":"page","operator":"is","values":["/pricing"]}]. `operator` is `is` or `is_not` and defaults to `is`; `values` are ORed within one filter. At most 3 filters, 100 values each. JSON rather than a delimited string because the values are merchant data - URLs with commas, campaign names with equals signs - and every delimiter worth choosing appears inside some legitimate value. Dimensions: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term, channel. `channel` is not a stored column: it is resolved against the window's real acquisition tuples using the same classifier the Channels card uses, so clicking a channel row cannot select a different set than that row claimed. THE SAME FILTERS MUST BE SENT TO EVERY REPORT ON A PAGE - a filtered chart beside an unfiltered tile is worse than no filtering, because the tiles are the numbers a merchant quotes.
|
|
4905
4913
|
*/
|
|
@@ -4936,6 +4944,14 @@ type GetAnalyticsTimeseriesData = {
|
|
|
4936
4944
|
* 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.
|
|
4937
4945
|
*/
|
|
4938
4946
|
period?: "7" | "30" | "90";
|
|
4947
|
+
/**
|
|
4948
|
+
* 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.
|
|
4949
|
+
*/
|
|
4950
|
+
from?: string;
|
|
4951
|
+
/**
|
|
4952
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
4953
|
+
*/
|
|
4954
|
+
to?: string;
|
|
4939
4955
|
/**
|
|
4940
4956
|
* Drill-down filters as a JSON array, ANDed with each other: [{"dimension":"page","operator":"is","values":["/pricing"]}]. `operator` is `is` or `is_not` and defaults to `is`; `values` are ORed within one filter. At most 3 filters, 100 values each. JSON rather than a delimited string because the values are merchant data - URLs with commas, campaign names with equals signs - and every delimiter worth choosing appears inside some legitimate value. Dimensions: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term, channel. `channel` is not a stored column: it is resolved against the window's real acquisition tuples using the same classifier the Channels card uses, so clicking a channel row cannot select a different set than that row claimed. THE SAME FILTERS MUST BE SENT TO EVERY REPORT ON A PAGE - a filtered chart beside an unfiltered tile is worse than no filtering, because the tiles are the numbers a merchant quotes.
|
|
4941
4957
|
*/
|
|
@@ -4994,8 +5010,20 @@ type GetAnalyticsSourcesData = {
|
|
|
4994
5010
|
query?: {
|
|
4995
5011
|
site_id?: string;
|
|
4996
5012
|
period?: "7" | "30" | "90";
|
|
5013
|
+
/**
|
|
5014
|
+
* 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.
|
|
5015
|
+
*/
|
|
5016
|
+
from?: string;
|
|
5017
|
+
/**
|
|
5018
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5019
|
+
*/
|
|
5020
|
+
to?: string;
|
|
4997
5021
|
limit?: string;
|
|
4998
5022
|
filters?: string;
|
|
5023
|
+
/**
|
|
5024
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5025
|
+
*/
|
|
5026
|
+
dimension2?: string;
|
|
4999
5027
|
};
|
|
5000
5028
|
url: "/api/v1/analytics/sources";
|
|
5001
5029
|
};
|
|
@@ -5022,8 +5050,20 @@ type GetAnalyticsCampaignsData = {
|
|
|
5022
5050
|
query?: {
|
|
5023
5051
|
site_id?: string;
|
|
5024
5052
|
period?: "7" | "30" | "90";
|
|
5053
|
+
/**
|
|
5054
|
+
* 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.
|
|
5055
|
+
*/
|
|
5056
|
+
from?: string;
|
|
5057
|
+
/**
|
|
5058
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5059
|
+
*/
|
|
5060
|
+
to?: string;
|
|
5025
5061
|
limit?: string;
|
|
5026
5062
|
filters?: string;
|
|
5063
|
+
/**
|
|
5064
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5065
|
+
*/
|
|
5066
|
+
dimension2?: string;
|
|
5027
5067
|
};
|
|
5028
5068
|
url: "/api/v1/analytics/campaigns";
|
|
5029
5069
|
};
|
|
@@ -5050,8 +5090,20 @@ type GetAnalyticsUtmMediumData = {
|
|
|
5050
5090
|
query?: {
|
|
5051
5091
|
site_id?: string;
|
|
5052
5092
|
period?: "7" | "30" | "90";
|
|
5093
|
+
/**
|
|
5094
|
+
* 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.
|
|
5095
|
+
*/
|
|
5096
|
+
from?: string;
|
|
5097
|
+
/**
|
|
5098
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5099
|
+
*/
|
|
5100
|
+
to?: string;
|
|
5053
5101
|
limit?: string;
|
|
5054
5102
|
filters?: string;
|
|
5103
|
+
/**
|
|
5104
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5105
|
+
*/
|
|
5106
|
+
dimension2?: string;
|
|
5055
5107
|
};
|
|
5056
5108
|
url: "/api/v1/analytics/utm/medium";
|
|
5057
5109
|
};
|
|
@@ -5078,8 +5130,20 @@ type GetAnalyticsUtmSourceData = {
|
|
|
5078
5130
|
query?: {
|
|
5079
5131
|
site_id?: string;
|
|
5080
5132
|
period?: "7" | "30" | "90";
|
|
5133
|
+
/**
|
|
5134
|
+
* 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.
|
|
5135
|
+
*/
|
|
5136
|
+
from?: string;
|
|
5137
|
+
/**
|
|
5138
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5139
|
+
*/
|
|
5140
|
+
to?: string;
|
|
5081
5141
|
limit?: string;
|
|
5082
5142
|
filters?: string;
|
|
5143
|
+
/**
|
|
5144
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5145
|
+
*/
|
|
5146
|
+
dimension2?: string;
|
|
5083
5147
|
};
|
|
5084
5148
|
url: "/api/v1/analytics/utm/source";
|
|
5085
5149
|
};
|
|
@@ -5106,8 +5170,20 @@ type GetAnalyticsUtmCampaignData = {
|
|
|
5106
5170
|
query?: {
|
|
5107
5171
|
site_id?: string;
|
|
5108
5172
|
period?: "7" | "30" | "90";
|
|
5173
|
+
/**
|
|
5174
|
+
* 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.
|
|
5175
|
+
*/
|
|
5176
|
+
from?: string;
|
|
5177
|
+
/**
|
|
5178
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5179
|
+
*/
|
|
5180
|
+
to?: string;
|
|
5109
5181
|
limit?: string;
|
|
5110
5182
|
filters?: string;
|
|
5183
|
+
/**
|
|
5184
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5185
|
+
*/
|
|
5186
|
+
dimension2?: string;
|
|
5111
5187
|
};
|
|
5112
5188
|
url: "/api/v1/analytics/utm/campaign";
|
|
5113
5189
|
};
|
|
@@ -5134,8 +5210,20 @@ type GetAnalyticsUtmContentData = {
|
|
|
5134
5210
|
query?: {
|
|
5135
5211
|
site_id?: string;
|
|
5136
5212
|
period?: "7" | "30" | "90";
|
|
5213
|
+
/**
|
|
5214
|
+
* 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.
|
|
5215
|
+
*/
|
|
5216
|
+
from?: string;
|
|
5217
|
+
/**
|
|
5218
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5219
|
+
*/
|
|
5220
|
+
to?: string;
|
|
5137
5221
|
limit?: string;
|
|
5138
5222
|
filters?: string;
|
|
5223
|
+
/**
|
|
5224
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5225
|
+
*/
|
|
5226
|
+
dimension2?: string;
|
|
5139
5227
|
};
|
|
5140
5228
|
url: "/api/v1/analytics/utm/content";
|
|
5141
5229
|
};
|
|
@@ -5162,8 +5250,20 @@ type GetAnalyticsUtmTermData = {
|
|
|
5162
5250
|
query?: {
|
|
5163
5251
|
site_id?: string;
|
|
5164
5252
|
period?: "7" | "30" | "90";
|
|
5253
|
+
/**
|
|
5254
|
+
* 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.
|
|
5255
|
+
*/
|
|
5256
|
+
from?: string;
|
|
5257
|
+
/**
|
|
5258
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5259
|
+
*/
|
|
5260
|
+
to?: string;
|
|
5165
5261
|
limit?: string;
|
|
5166
5262
|
filters?: string;
|
|
5263
|
+
/**
|
|
5264
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5265
|
+
*/
|
|
5266
|
+
dimension2?: string;
|
|
5167
5267
|
};
|
|
5168
5268
|
url: "/api/v1/analytics/utm/term";
|
|
5169
5269
|
};
|
|
@@ -5190,8 +5290,20 @@ type GetAnalyticsPagesData = {
|
|
|
5190
5290
|
query?: {
|
|
5191
5291
|
site_id?: string;
|
|
5192
5292
|
period?: "7" | "30" | "90";
|
|
5293
|
+
/**
|
|
5294
|
+
* 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.
|
|
5295
|
+
*/
|
|
5296
|
+
from?: string;
|
|
5297
|
+
/**
|
|
5298
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5299
|
+
*/
|
|
5300
|
+
to?: string;
|
|
5193
5301
|
limit?: string;
|
|
5194
5302
|
filters?: string;
|
|
5303
|
+
/**
|
|
5304
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5305
|
+
*/
|
|
5306
|
+
dimension2?: string;
|
|
5195
5307
|
};
|
|
5196
5308
|
url: "/api/v1/analytics/pages";
|
|
5197
5309
|
};
|
|
@@ -5218,8 +5330,20 @@ type GetAnalyticsEntryPagesData = {
|
|
|
5218
5330
|
query?: {
|
|
5219
5331
|
site_id?: string;
|
|
5220
5332
|
period?: "7" | "30" | "90";
|
|
5333
|
+
/**
|
|
5334
|
+
* 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.
|
|
5335
|
+
*/
|
|
5336
|
+
from?: string;
|
|
5337
|
+
/**
|
|
5338
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5339
|
+
*/
|
|
5340
|
+
to?: string;
|
|
5221
5341
|
limit?: string;
|
|
5222
5342
|
filters?: string;
|
|
5343
|
+
/**
|
|
5344
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5345
|
+
*/
|
|
5346
|
+
dimension2?: string;
|
|
5223
5347
|
};
|
|
5224
5348
|
url: "/api/v1/analytics/entry-pages";
|
|
5225
5349
|
};
|
|
@@ -5246,8 +5370,20 @@ type GetAnalyticsExitPagesData = {
|
|
|
5246
5370
|
query?: {
|
|
5247
5371
|
site_id?: string;
|
|
5248
5372
|
period?: "7" | "30" | "90";
|
|
5373
|
+
/**
|
|
5374
|
+
* 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.
|
|
5375
|
+
*/
|
|
5376
|
+
from?: string;
|
|
5377
|
+
/**
|
|
5378
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5379
|
+
*/
|
|
5380
|
+
to?: string;
|
|
5249
5381
|
limit?: string;
|
|
5250
5382
|
filters?: string;
|
|
5383
|
+
/**
|
|
5384
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5385
|
+
*/
|
|
5386
|
+
dimension2?: string;
|
|
5251
5387
|
};
|
|
5252
5388
|
url: "/api/v1/analytics/exit-pages";
|
|
5253
5389
|
};
|
|
@@ -5274,8 +5410,20 @@ type GetAnalyticsCountriesData = {
|
|
|
5274
5410
|
query?: {
|
|
5275
5411
|
site_id?: string;
|
|
5276
5412
|
period?: "7" | "30" | "90";
|
|
5413
|
+
/**
|
|
5414
|
+
* 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.
|
|
5415
|
+
*/
|
|
5416
|
+
from?: string;
|
|
5417
|
+
/**
|
|
5418
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5419
|
+
*/
|
|
5420
|
+
to?: string;
|
|
5277
5421
|
limit?: string;
|
|
5278
5422
|
filters?: string;
|
|
5423
|
+
/**
|
|
5424
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5425
|
+
*/
|
|
5426
|
+
dimension2?: string;
|
|
5279
5427
|
};
|
|
5280
5428
|
url: "/api/v1/analytics/countries";
|
|
5281
5429
|
};
|
|
@@ -5302,8 +5450,20 @@ type GetAnalyticsRegionsData = {
|
|
|
5302
5450
|
query?: {
|
|
5303
5451
|
site_id?: string;
|
|
5304
5452
|
period?: "7" | "30" | "90";
|
|
5453
|
+
/**
|
|
5454
|
+
* 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.
|
|
5455
|
+
*/
|
|
5456
|
+
from?: string;
|
|
5457
|
+
/**
|
|
5458
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5459
|
+
*/
|
|
5460
|
+
to?: string;
|
|
5305
5461
|
limit?: string;
|
|
5306
5462
|
filters?: string;
|
|
5463
|
+
/**
|
|
5464
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5465
|
+
*/
|
|
5466
|
+
dimension2?: string;
|
|
5307
5467
|
};
|
|
5308
5468
|
url: "/api/v1/analytics/regions";
|
|
5309
5469
|
};
|
|
@@ -5330,8 +5490,20 @@ type GetAnalyticsCitiesData = {
|
|
|
5330
5490
|
query?: {
|
|
5331
5491
|
site_id?: string;
|
|
5332
5492
|
period?: "7" | "30" | "90";
|
|
5493
|
+
/**
|
|
5494
|
+
* 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.
|
|
5495
|
+
*/
|
|
5496
|
+
from?: string;
|
|
5497
|
+
/**
|
|
5498
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5499
|
+
*/
|
|
5500
|
+
to?: string;
|
|
5333
5501
|
limit?: string;
|
|
5334
5502
|
filters?: string;
|
|
5503
|
+
/**
|
|
5504
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5505
|
+
*/
|
|
5506
|
+
dimension2?: string;
|
|
5335
5507
|
};
|
|
5336
5508
|
url: "/api/v1/analytics/cities";
|
|
5337
5509
|
};
|
|
@@ -5358,8 +5530,20 @@ type GetAnalyticsDevicesData = {
|
|
|
5358
5530
|
query?: {
|
|
5359
5531
|
site_id?: string;
|
|
5360
5532
|
period?: "7" | "30" | "90";
|
|
5533
|
+
/**
|
|
5534
|
+
* 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.
|
|
5535
|
+
*/
|
|
5536
|
+
from?: string;
|
|
5537
|
+
/**
|
|
5538
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5539
|
+
*/
|
|
5540
|
+
to?: string;
|
|
5361
5541
|
limit?: string;
|
|
5362
5542
|
filters?: string;
|
|
5543
|
+
/**
|
|
5544
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5545
|
+
*/
|
|
5546
|
+
dimension2?: string;
|
|
5363
5547
|
};
|
|
5364
5548
|
url: "/api/v1/analytics/devices";
|
|
5365
5549
|
};
|
|
@@ -5386,8 +5570,20 @@ type GetAnalyticsBrowsersData = {
|
|
|
5386
5570
|
query?: {
|
|
5387
5571
|
site_id?: string;
|
|
5388
5572
|
period?: "7" | "30" | "90";
|
|
5573
|
+
/**
|
|
5574
|
+
* 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.
|
|
5575
|
+
*/
|
|
5576
|
+
from?: string;
|
|
5577
|
+
/**
|
|
5578
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5579
|
+
*/
|
|
5580
|
+
to?: string;
|
|
5389
5581
|
limit?: string;
|
|
5390
5582
|
filters?: string;
|
|
5583
|
+
/**
|
|
5584
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5585
|
+
*/
|
|
5586
|
+
dimension2?: string;
|
|
5391
5587
|
};
|
|
5392
5588
|
url: "/api/v1/analytics/browsers";
|
|
5393
5589
|
};
|
|
@@ -5414,8 +5610,20 @@ type GetAnalyticsOperatingSystemsData = {
|
|
|
5414
5610
|
query?: {
|
|
5415
5611
|
site_id?: string;
|
|
5416
5612
|
period?: "7" | "30" | "90";
|
|
5613
|
+
/**
|
|
5614
|
+
* 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.
|
|
5615
|
+
*/
|
|
5616
|
+
from?: string;
|
|
5617
|
+
/**
|
|
5618
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5619
|
+
*/
|
|
5620
|
+
to?: string;
|
|
5417
5621
|
limit?: string;
|
|
5418
5622
|
filters?: string;
|
|
5623
|
+
/**
|
|
5624
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5625
|
+
*/
|
|
5626
|
+
dimension2?: string;
|
|
5419
5627
|
};
|
|
5420
5628
|
url: "/api/v1/analytics/operating-systems";
|
|
5421
5629
|
};
|
|
@@ -5442,6 +5650,14 @@ type GetAnalyticsChannelsData = {
|
|
|
5442
5650
|
query?: {
|
|
5443
5651
|
site_id?: string;
|
|
5444
5652
|
period?: "7" | "30" | "90";
|
|
5653
|
+
/**
|
|
5654
|
+
* 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.
|
|
5655
|
+
*/
|
|
5656
|
+
from?: string;
|
|
5657
|
+
/**
|
|
5658
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5659
|
+
*/
|
|
5660
|
+
to?: string;
|
|
5445
5661
|
filters?: string;
|
|
5446
5662
|
};
|
|
5447
5663
|
url: "/api/v1/analytics/channels";
|
|
@@ -9787,13 +10003,13 @@ declare const getAnalyticsStatus: <ThrowOnError extends boolean = false>(options
|
|
|
9787
10003
|
/**
|
|
9788
10004
|
* Top-line metrics with period-over-period comparison
|
|
9789
10005
|
*
|
|
9790
|
-
* Visitors, visits, pageviews, views per visit, bounce rate and mean visit duration for the period, plus the immediately preceding same-length window for deltas. `previous` is null when that window is not fully covered by collection. Note the two scopings: visits, bounce rate and duration describe visits that STARTED in the window; pageviews and visitors count events INSIDE it, which is what keeps this tile agreeing with the chart beside it.
|
|
10006
|
+
* Visitors, visits, pageviews, views per visit, bounce rate and mean visit duration for the period, plus the immediately preceding same-length window for deltas. `previous` is null when that window is not fully covered by collection. Note the two scopings: visits, bounce rate and duration describe visits that STARTED in the window; pageviews and visitors count events INSIDE it, which is what keeps this tile agreeing with the chart beside it. Use `from`/`to` in place of `period` for an explicit range; the comparison is then the same number of days immediately before it.
|
|
9791
10007
|
*/
|
|
9792
10008
|
declare const getAnalyticsSummary: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsSummaryData, ThrowOnError>) => RequestResult<GetAnalyticsSummaryResponses, GetAnalyticsSummaryErrors, ThrowOnError, "fields">;
|
|
9793
10009
|
/**
|
|
9794
10010
|
* Visitors by day for the period
|
|
9795
10011
|
*
|
|
9796
|
-
* One row per local day with traffic, bucketed in the site's reporting timezone. Days with no traffic are omitted rather than zero-filled.
|
|
10012
|
+
* One row per local day with traffic, bucketed in the site's reporting timezone. Days with no traffic are omitted rather than zero-filled. Use `from`/`to` in place of `period` for an explicit range. Day is the only bucket size: sub-day and multi-day buckets would need a pipe change, not a parameter.
|
|
9797
10013
|
*/
|
|
9798
10014
|
declare const getAnalyticsTimeseries: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsTimeseriesData, ThrowOnError>) => RequestResult<GetAnalyticsTimeseriesResponses, GetAnalyticsTimeseriesErrors, ThrowOnError, "fields">;
|
|
9799
10015
|
/**
|
|
@@ -9805,97 +10021,97 @@ declare const getAnalyticsRealtime: <ThrowOnError extends boolean = false>(optio
|
|
|
9805
10021
|
/**
|
|
9806
10022
|
* source breakdown for the period
|
|
9807
10023
|
*
|
|
9808
|
-
* Ranked source rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10024
|
+
* Ranked source rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. This report rejects `dimension2` whatever is asked for: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. Ask for the other report crossed the other way up instead. The 400 names the alternative for the dimension asked for.
|
|
9809
10025
|
*/
|
|
9810
10026
|
declare const getAnalyticsSources: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsSourcesData, ThrowOnError>) => RequestResult<GetAnalyticsSourcesResponses, GetAnalyticsSourcesErrors, ThrowOnError, "fields">;
|
|
9811
10027
|
/**
|
|
9812
10028
|
* campaign breakdown for the period
|
|
9813
10029
|
*
|
|
9814
|
-
* Ranked campaign rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10030
|
+
* Ranked campaign rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (visits) — crossing never changes what the count means.
|
|
9815
10031
|
*/
|
|
9816
10032
|
declare const getAnalyticsCampaigns: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsCampaignsData, ThrowOnError>) => RequestResult<GetAnalyticsCampaignsResponses, GetAnalyticsCampaignsErrors, ThrowOnError, "fields">;
|
|
9817
10033
|
/**
|
|
9818
10034
|
* utm_medium breakdown for the period
|
|
9819
10035
|
*
|
|
9820
|
-
* Ranked utm_medium rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10036
|
+
* Ranked utm_medium rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (visits) — crossing never changes what the count means.
|
|
9821
10037
|
*/
|
|
9822
10038
|
declare const getAnalyticsUtmMedium: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmMediumData, ThrowOnError>) => RequestResult<GetAnalyticsUtmMediumResponses, GetAnalyticsUtmMediumErrors, ThrowOnError, "fields">;
|
|
9823
10039
|
/**
|
|
9824
10040
|
* utm_source breakdown for the period
|
|
9825
10041
|
*
|
|
9826
|
-
* Ranked utm_source rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10042
|
+
* Ranked utm_source rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (visits) — crossing never changes what the count means.
|
|
9827
10043
|
*/
|
|
9828
10044
|
declare const getAnalyticsUtmSource: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmSourceData, ThrowOnError>) => RequestResult<GetAnalyticsUtmSourceResponses, GetAnalyticsUtmSourceErrors, ThrowOnError, "fields">;
|
|
9829
10045
|
/**
|
|
9830
10046
|
* campaign breakdown for the period
|
|
9831
10047
|
*
|
|
9832
|
-
* Ranked campaign rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10048
|
+
* Ranked campaign rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (visits) — crossing never changes what the count means.
|
|
9833
10049
|
*/
|
|
9834
10050
|
declare const getAnalyticsUtmCampaign: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmCampaignData, ThrowOnError>) => RequestResult<GetAnalyticsUtmCampaignResponses, GetAnalyticsUtmCampaignErrors, ThrowOnError, "fields">;
|
|
9835
10051
|
/**
|
|
9836
10052
|
* utm_content breakdown for the period
|
|
9837
10053
|
*
|
|
9838
|
-
* Ranked utm_content rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10054
|
+
* Ranked utm_content rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (visits) — crossing never changes what the count means.
|
|
9839
10055
|
*/
|
|
9840
10056
|
declare const getAnalyticsUtmContent: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmContentData, ThrowOnError>) => RequestResult<GetAnalyticsUtmContentResponses, GetAnalyticsUtmContentErrors, ThrowOnError, "fields">;
|
|
9841
10057
|
/**
|
|
9842
10058
|
* utm_term breakdown for the period
|
|
9843
10059
|
*
|
|
9844
|
-
* Ranked utm_term rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10060
|
+
* Ranked utm_term rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (visits) — crossing never changes what the count means.
|
|
9845
10061
|
*/
|
|
9846
10062
|
declare const getAnalyticsUtmTerm: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmTermData, ThrowOnError>) => RequestResult<GetAnalyticsUtmTermResponses, GetAnalyticsUtmTermErrors, ThrowOnError, "fields">;
|
|
9847
10063
|
/**
|
|
9848
10064
|
* pathname breakdown for the period
|
|
9849
10065
|
*
|
|
9850
|
-
* Ranked pathname rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10066
|
+
* Ranked pathname rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (pageviews) — crossing never changes what the count means.
|
|
9851
10067
|
*/
|
|
9852
10068
|
declare const getAnalyticsPages: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsPagesData, ThrowOnError>) => RequestResult<GetAnalyticsPagesResponses, GetAnalyticsPagesErrors, ThrowOnError, "fields">;
|
|
9853
10069
|
/**
|
|
9854
10070
|
* pathname breakdown for the period
|
|
9855
10071
|
*
|
|
9856
|
-
* Ranked pathname rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10072
|
+
* Ranked pathname rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (entries) — crossing never changes what the count means.
|
|
9857
10073
|
*/
|
|
9858
10074
|
declare const getAnalyticsEntryPages: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsEntryPagesData, ThrowOnError>) => RequestResult<GetAnalyticsEntryPagesResponses, GetAnalyticsEntryPagesErrors, ThrowOnError, "fields">;
|
|
9859
10075
|
/**
|
|
9860
10076
|
* pathname breakdown for the period
|
|
9861
10077
|
*
|
|
9862
|
-
* Ranked pathname rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10078
|
+
* Ranked pathname rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (exits) — crossing never changes what the count means.
|
|
9863
10079
|
*/
|
|
9864
10080
|
declare const getAnalyticsExitPages: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsExitPagesData, ThrowOnError>) => RequestResult<GetAnalyticsExitPagesResponses, GetAnalyticsExitPagesErrors, ThrowOnError, "fields">;
|
|
9865
10081
|
/**
|
|
9866
10082
|
* country breakdown for the period
|
|
9867
10083
|
*
|
|
9868
|
-
* Ranked country rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10084
|
+
* Ranked country rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (pageviews) — crossing never changes what the count means.
|
|
9869
10085
|
*/
|
|
9870
10086
|
declare const getAnalyticsCountries: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsCountriesData, ThrowOnError>) => RequestResult<GetAnalyticsCountriesResponses, GetAnalyticsCountriesErrors, ThrowOnError, "fields">;
|
|
9871
10087
|
/**
|
|
9872
10088
|
* region breakdown for the period
|
|
9873
10089
|
*
|
|
9874
|
-
* Ranked region rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10090
|
+
* Ranked region rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. This report rejects `dimension2` whatever is asked for: it already spends the pipe's one second slot on country, without which its values cannot be told apart. Ask for the other report crossed the other way up instead. The 400 names the alternative for the dimension asked for.
|
|
9875
10091
|
*/
|
|
9876
10092
|
declare const getAnalyticsRegions: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsRegionsData, ThrowOnError>) => RequestResult<GetAnalyticsRegionsResponses, GetAnalyticsRegionsErrors, ThrowOnError, "fields">;
|
|
9877
10093
|
/**
|
|
9878
10094
|
* city breakdown for the period
|
|
9879
10095
|
*
|
|
9880
|
-
* Ranked city rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10096
|
+
* Ranked city rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. This report rejects `dimension2` whatever is asked for: it already spends the pipe's one second slot on country, without which its values cannot be told apart. Ask for the other report crossed the other way up instead. The 400 names the alternative for the dimension asked for.
|
|
9881
10097
|
*/
|
|
9882
10098
|
declare const getAnalyticsCities: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsCitiesData, ThrowOnError>) => RequestResult<GetAnalyticsCitiesResponses, GetAnalyticsCitiesErrors, ThrowOnError, "fields">;
|
|
9883
10099
|
/**
|
|
9884
10100
|
* device breakdown for the period
|
|
9885
10101
|
*
|
|
9886
|
-
* Ranked device rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10102
|
+
* Ranked device rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (pageviews) — crossing never changes what the count means.
|
|
9887
10103
|
*/
|
|
9888
10104
|
declare const getAnalyticsDevices: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsDevicesData, ThrowOnError>) => RequestResult<GetAnalyticsDevicesResponses, GetAnalyticsDevicesErrors, ThrowOnError, "fields">;
|
|
9889
10105
|
/**
|
|
9890
10106
|
* browser breakdown for the period
|
|
9891
10107
|
*
|
|
9892
|
-
* Ranked browser rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10108
|
+
* Ranked browser rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (pageviews) — crossing never changes what the count means.
|
|
9893
10109
|
*/
|
|
9894
10110
|
declare const getAnalyticsBrowsers: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsBrowsersData, ThrowOnError>) => RequestResult<GetAnalyticsBrowsersResponses, GetAnalyticsBrowsersErrors, ThrowOnError, "fields">;
|
|
9895
10111
|
/**
|
|
9896
10112
|
* os breakdown for the period
|
|
9897
10113
|
*
|
|
9898
|
-
* Ranked os rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
10114
|
+
* Ranked os rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (pageviews) — crossing never changes what the count means.
|
|
9899
10115
|
*/
|
|
9900
10116
|
declare const getAnalyticsOperatingSystems: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsOperatingSystemsData, ThrowOnError>) => RequestResult<GetAnalyticsOperatingSystemsResponses, GetAnalyticsOperatingSystemsErrors, ThrowOnError, "fields">;
|
|
9901
10117
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aifeatures/backend",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.11.0",
|
|
4
4
|
"description": "TypeScript API client for aifeatures backend",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -21,6 +21,13 @@
|
|
|
21
21
|
"files": [
|
|
22
22
|
"dist"
|
|
23
23
|
],
|
|
24
|
+
"scripts": {
|
|
25
|
+
"generate": "openapi-ts",
|
|
26
|
+
"build": "tsup",
|
|
27
|
+
"prepack": "pnpm build",
|
|
28
|
+
"dev": "tsup --watch",
|
|
29
|
+
"typecheck": "tsc --noEmit"
|
|
30
|
+
},
|
|
24
31
|
"devDependencies": {
|
|
25
32
|
"@hey-api/openapi-ts": "0.89.2",
|
|
26
33
|
"tsup": "^8.3.5",
|
|
@@ -28,11 +35,5 @@
|
|
|
28
35
|
},
|
|
29
36
|
"dependencies": {
|
|
30
37
|
"@hey-api/client-fetch": "0.13.1"
|
|
31
|
-
},
|
|
32
|
-
"scripts": {
|
|
33
|
-
"generate": "openapi-ts",
|
|
34
|
-
"build": "tsup",
|
|
35
|
-
"dev": "tsup --watch",
|
|
36
|
-
"typecheck": "tsc --noEmit"
|
|
37
38
|
}
|
|
38
|
-
}
|
|
39
|
+
}
|