Branded vs non-branded performance
get_branded_performanceSplits a property's search performance into BRANDED and NON-BRANDED using the branded keywords saved on the property (set them with update_site; a keyword wrapped in slashes like /acme ?corp/ is treated as a regex, otherwise it is a case-insensitive substring). Returns totals, the branded share of clicks, a daily clicks trend for both sides, and the top queries on each side, with optional comparison-period totals. nonBranded is the property total minus branded, so the two sides add up to the property total (total) and brandedClickShare is branded clicks over that total. Search Console leaves anonymised queries out of any query-filtered read, so they cannot be matched against the keywords; they are rare, long-tail searches, counted in nonBranded and also reported on their own as anonymized. topNonBrandedQueries lists named queries only. Returns notConfigured (not an error) when the property has no branded keywords yet. Served from the GSC Wizard ClickHouse warehouse when available, otherwise the live Search Console API (see dataSource). 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 |
|---|---|---|---|
| limit | No | How many top queries to return per side. | |
| 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 | |
| comparisonEndDate | No | Optional. End of the comparison period as YYYY-MM-DD. Provide BOTH comparison dates to compare two periods; omit both for no comparison (prev* fields are then 0 and hasComparison false). | |
| comparisonStartDate | No | Optional. Start of the comparison period as YYYY-MM-DD. Provide BOTH comparison dates to compare two periods; omit both for no comparison (prev* fields are then 0 and hasComparison false). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hint | No | ||
| note | No | ||
| daily | No | ||
| range | No | ||
| total | No | ||
| reason | No | ||
| branded | No | ||
| siteUrl | No | ||
| previous | No | ||
| anonymized | No | ||
| dataSource | No | ||
| nonBranded | No | ||
| searchType | No | ||
| dataMaturity | No | ||
| hasComparison | No | ||
| notConfigured | No | ||
| savedKeywords | No | ||
| settledThrough | No | ||
| brandedKeywords | No | ||
| comparisonRange | No | ||
| brandedClickShare | No | ||
| topBrandedQueries | No | ||
| brandedKeywordCount | No | ||
| warehouseLatestDate | No | ||
| topNonBrandedQueries | No |