Brand split and position bands
get_breakdownSplits the period's traffic into branded/nonBranded (by the property's branded_terms) and into position bands (1-3, 4-10, 11-20, 21+) with impressions and clicks per band, plus queryCount. Position of each query = impression-weighted average over the period. Without branded terms on the property everything counts as nonBranded and the response says where to set them. Use for "how much of our traffic is brand" and "how much sits on page 2". / Marca × sem marca e faixas de posição.
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. | |
| query | No | Only queries containing this text, or a regex as /…/ (e.g. "/^how to/"; no flag = case-insensitive). | |
| device | No | Device. | |
| 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. | |
| 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/". |