Get workspace brand terms
The brand terms a workspace matches queries and AI answers against: `brandTerms` is the effective list (title plus confirmed aliases) and is what analyze_branded_vs_nonbranded and find_low_hanging_keywords actually use.
Tool name: get_workspace_brand_terms
Cost: Free - not billed, and does not draw on a plan quota.
Read-only
This tool only reads. It never creates or changes anything, so an assistant may call it without asking you first.
The brand terms a workspace matches queries and AI answers against: brandTerms is the effective list (title plus confirmed aliases) and is what analyze_branded_vs_nonbranded and find_low_hanging_keywords actually use. aliases is the editable set behind it, each tagged derived (proposed by workspace analysis and confirmed) or user (typed by someone). candidates are proposals still awaiting confirmation - they are never matched against until promoted with set_workspace_brand_terms. Takes a workspaceId, not a site; call list_workspaces or list_sites if you only know the domain.
Parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
workspaceId | string (uuid) | Yes | - |
Full input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": ["workspaceId"]
}Response
Full output JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string"
},
"brandTerms": {
"type": "array",
"items": {
"type": "string"
}
},
"aliases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"origin": {
"type": "string"
}
},
"required": ["alias", "origin"],
"additionalProperties": {}
}
},
"candidates": {
"type": "array",
"items": {
"type": "string"
}
},
"rejected": {
"type": "array",
"items": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"reason": {
"type": "string"
}
},
"required": ["alias", "reason"],
"additionalProperties": {}
}
}
},
"required": [
"workspaceId",
"title",
"brandTerms",
"aliases",
"candidates",
"rejected"
],
"additionalProperties": false
}Analyze branded vs non-branded search
Splits the window's Google + Bing queries into branded and non-branded demand and reports each side's clicks, impressions, CTR, average position and share of the engine's total.
Score SEO opportunities
One prioritized queue over four tools that each answer a different question: find_low_hanging_keywords, find_ctr_opportunities, find_content_decay and find_content_gaps.