By subdomain and folder
breakdown_by_pathGroups the property's pages by host (subdomain) and by the first depth path segments (1–4), e.g. "example.com/blog/*": pages per group, clicks, impressions, ctr, position, clickShare, comparison (prevClicks, clicksChange, clicksChangePct, positionChange) and the top 3 pages of each group. Sorted by clicks. Use for "which section drives traffic", "is the blog growing", "how is the /pt/ folder doing" and to compare subdomains. / Tráfego por subdomínio e pasta (profundidade 1–4).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| days | No | Window length in days (default 28). Ignored when startDate and endDate are both given. / Janela em dias. | |
| site | Yes | Property: displayName ("example.com"), Search Console siteUrl ("sc-domain:example.com", "https://www.example.com/") or numeric id. A unique substring among visible properties also works ("exam"). list_sites shows the options. / Propriedade por nome, siteUrl ou id. | |
| brand | No | all (default); branded = only queries containing one of the property's branded_terms; non-branded = the rest. Needs branded terms set on the property in the Organiq panel, otherwise invalid_argument with the panel URL. / Marca × sem marca. | |
| depth | No | Path depth (default 1: first folder). | |
| limit | No | Groups (default 50). | |
| query | No | Only queries containing this text, or a regex as /…/ (e.g. "/^how to/"; no flag = case-insensitive). | |
| device | No | Device. | |
| compare | No | Comparison: previous (default) = same-length window immediately before; year = same dates one year earlier; none. / Comparação. | |
| country | No | Country as ISO-3166-1 alpha-3, as in Search Console: bra, usa, prt, arg. | |
| endDate | No | End yyyy-mm-dd. Default: last synced date of the property (Search Console lags ~3 days; never "today"). Every response states the period used. / Fim; padrão = última data sincronizada. | |
| minClicks | No | Hide groups with fewer clicks than this in both periods (default 0). | |
| startDate | No | Start yyyy-mm-dd. Default: endDate − (days − 1). | |
| searchType | No | Search type (default web). | |
| pageContains | No | Only pages whose URL contains this text (case-insensitive), e.g. "/blog/". |