Success metric#
See how an AI assistant can help with success metric in Brandwave, including example prompts and the details it may ask for.
Using your AI assistant
Get success metric#
Get the workspace's success metric: the one number it treats as success, in its own words (sign ups, purchases, booked meetings), and the GA4 event that counts it when one is linked. Name is null until the workspace says what success is.
Tool name: get_success_metric. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt#
Show me the details for this success metric.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string (UUID) | Required | Workspace identifier. |
What you'll get back#
Returns { data, _meta } with the result.
Set success metric#
Update the workspace's success metric: its name in the workspace's own words and, optionally, the GA4 event that counts it. Linking a different event stops tracking the old one and removes its synced counts. An event tracked as an interest action becomes the success metric instead. Event history is backfilled automatically.
Tool name: set_success_metric. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=false, openWorldHint=false.
Example prompt#
Set success metric for my workspace.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string (UUID) | Required | Workspace identifier. |
| name | string | Required | The one number this workspace treats as success, in its own words, such as "Sign ups" or "Booked meetings". |
| event | object | null | — | The GA4 event that counts the success metric. Null unlinks it; leave it out to keep the current link. History is backfilled when a new event is linked. |
What you'll get back#
Returns { data, _meta } with the result.
Replace success metric dimensions#
Select which registered GA4 custom dimensions to read for the success metric's event, such as a "how did you hear about us" answer, and backfill their counts.
Tool name: replace_success_metric_dimensions. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=false, openWorldHint=false.
Example prompt#
Replace success metric dimensions for my workspace.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string (UUID) | Required | Workspace identifier. |
| dimensions | Array<object> | Required | Every registered GA4 custom dimension to read for the success metric's event. |
What you'll get back#
Returns { items, totalCount, facets, _meta } with paginated results.