Breakdown by subdomain / path
breakdown_by_pathAggregates page-level performance into a subdomain and first-folder breakdown. Each page URL is parsed and grouped by its host plus the first depth path segments (depth 1 -> /folder, depth 2 -> /folder/subfolder, etc.). Returns per-group clicks, impressions, CTR, impression-weighted average position, and the number of distinct pages. Served from the ClickHouse warehouse when available (every page is grouped), otherwise the live Search Console API (up to 25,000 page rows are grouped; see dataSource). truncated says when pages or groups were left out. Date range is optional: omit startDate/endDate to analyze the last 28 settled days (data lags ~2-3 days).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| depth | No | ||
| limit | No | ||
| endDate | No | Optional. Window end as YYYY-MM-DD (e.g. 2026-05-31). You do NOT need to know today's date or the latest available date: omit this and the server uses the latest settled Search Console date (data lags ~2-3 days behind today). Never pass null or the string "null". | |
| siteUrl | Yes | ||
| startDate | No | Optional. Window start as YYYY-MM-DD (e.g. 2026-05-03). You do NOT need to know today's date. Omit BOTH startDate and endDate to analyze the last 28 settled days automatically (Search Console data lags ~2-3 days). Never pass null or the string "null". | |
| searchType | No | web |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| depth | No | ||
| range | No | ||
| groups | No | ||
| siteUrl | No | ||
| truncated | No | ||
| dataSource | No | ||
| groupCount | No | ||
| dataMaturity | No | ||
| pageRowsCapped | No | ||
| settledThrough | No | ||
| truncationNote | No | ||
| warehouseLatestDate | No |