Success metrics#
See how an AI assistant can help with success metrics in Brandwave, including example prompts and the details it may ask for.
Using your AI assistant
List success metrics#
List the organization's selected success metrics: the GA4 events it defines as success (e.g. sign-ups, purchases).
Tool name: list_success_metrics. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt#
List all success metrics in my organization.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
What you'll get back#
Returns { items, totalCount, facets, _meta } with paginated results.
Add success metrics#
Add success metrics, or replace the current selection during GA4 setup. Historical event data is backfilled automatically.
Tool name: add_success_metrics. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=false, openWorldHint=false.
Example prompt#
Add the success metrics.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| replaceExisting | boolean | — | When true, remove success metrics not included in this request before saving the selected metrics. |
| metrics | Array<object> | Required | Success metrics to add. An empty array clears all metrics when replaceExisting is true; otherwise it is a no-op. |
What you'll get back#
Returns { items, totalCount, facets, _meta } with paginated results.
Remove success metric#
Remove a success metric and purge its synced event data.
Tool name: remove_success_metric. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.
Example prompt#
Remove the success metric.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| successMetricId | string (UUID) | Required | Success metric identifier to remove. |
What you'll get back#
Returns { data, _meta } with the result.
Replace success metric dimensions#
Update the registered GA4 custom dimensions tracked for one success event and backfill their aggregate values.
Tool name: replace_success_metric_dimensions. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.
Example prompt#
Replace success metric dimensions for my organization.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| successMetricId | string (UUID) | Required | Success metric whose custom dimensions are replaced. |
| dimensions | Array<object> | Required | Desired registered event-scoped GA4 custom dimensions for this success metric. |
What you'll get back#
Returns { items, totalCount, facets, _meta } with paginated results.