Reported outcomes#
See how an AI assistant can help with reported outcomes in Brandwave, including example prompts and the details it may ask for.
Using your AI assistant
List outcome definitions#
List reusable reported outcome definitions for a workspace.
Tool name: list_outcome_definitions. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt#
List all outcome definitions in my workspace.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string (UUID) | Required | Workspace identifier. |
What you'll get back#
Returns { items, totalCount, facets, _meta } with paginated results.
Create outcome definition#
Create a reusable definition for a reported business or brand outcome such as sales value, awareness, or qualified inquiries, with a name, value kind, unit label, and default currency.
Tool name: create_outcome_definition. Protocol hints: readOnlyHint=false, destructiveHint=false, idempotentHint=false, openWorldHint=false.
Example prompt#
Create a new outcome definition.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string (UUID) | Required | Workspace identifier. |
| name | string | Required | Short name of the outcome, for example "Sales value" or "Qualified inquiries". |
| description | string | null | — | What the outcome measures and how it is normally sourced. |
| valueKind | 'count' | 'currency' | 'percentage' | 'ratio' | 'index' | 'duration' | 'other' | Required | What kind of quantity measurements carry: count, currency, percentage, ratio, index, duration, or other. |
| unitLabel | string | null | — | Unit shown after values, for example "inquiries" or "points". |
| defaultCurrency | string | null | — | ISO 4217 currency code applied to currency-kind measurements, for example "NZD". |
What you'll get back#
Returns { data, _meta } with the result.
Update outcome definition#
Update the name, description, value kind, unit label, or default currency of a reusable reported outcome definition.
Tool name: update_outcome_definition. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.
Example prompt#
Update the outcome definition.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | — | Short name of the outcome, for example "Sales value" or "Qualified inquiries". |
| description | string | null | — | What the outcome measures and how it is normally sourced. |
| valueKind | 'count' | 'currency' | 'percentage' | 'ratio' | 'index' | 'duration' | 'other' | — | What kind of quantity measurements carry: count, currency, percentage, ratio, index, duration, or other. |
| unitLabel | string | null | — | Unit shown after values, for example "inquiries" or "points". |
| defaultCurrency | string | null | — | ISO 4217 currency code applied to currency-kind measurements, for example "NZD". |
| id | string (UUID) | Required | Unique identifier (UUID v4). |
What you'll get back#
Returns { data, _meta } with the result.
Delete outcome definition#
Delete an unused reported outcome definition by soft deletion; definitions with active measurements are blocked.
Tool name: delete_outcome_definition. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.
Example prompt#
Delete this outcome definition.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Unique identifier (UUID v4). |
What you'll get back#
Returns { data, _meta } with the result.
List outcome measurements#
List reported outcome measurements for a campaign, including method, period, confidence, units, and definition.
Tool name: list_outcome_measurements. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt#
List all outcome measurements in my workspace.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string (UUID) | Required | Workspace identifier. |
| campaignId | string (UUID) | Required | Unique identifier (UUID v4). |
What you'll get back#
Returns { items, totalCount, facets, _meta } with paginated results.
Create outcome measurement#
Record a campaign-reported outcome measurement: the value, optional baseline value, reporting period start and end, market, source method, and confidence, stored as an append-only evidence claim.
Tool name: create_outcome_measurement. Protocol hints: readOnlyHint=false, destructiveHint=false, idempotentHint=false, openWorldHint=false.
Example prompt#
Create a new outcome measurement.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string (UUID) | Required | Workspace identifier. |
| campaignId | string (UUID) | Required | Unique identifier (UUID v4). |
| outcomeDefinitionId | string (UUID) | Required | The reusable outcome definition this measures. |
| periodStart | string | null | — | First day (YYYY-MM-DD) of the period the reported value covers. |
| periodEnd | string | null | — | Last day (YYYY-MM-DD) of the period; must be on or after periodStart. |
| value | number | Required | The reported outcome value, in the definition's value kind and unit. |
| baselineValue | unknown | — | Comparable value before the campaign, when the report supplied one. |
| market | string | null | — | Market or region the value applies to, for example "New Zealand". |
| sourceMethod | 'document_reported' | 'manual' | 'csv' | 'api' | Required | How the value was obtained: document_reported, manual entry, csv import, or api. Reported outcomes are claims, not observed attribution. |
| confidence | number | null | — | Reporter's confidence in the value from 0 (none) to 1 (certain). |
What you'll get back#
Returns { data, _meta } with the result.
Update outcome measurement#
Update the value, baseline, period start and end, market, source method, or confidence of a reported outcome measurement, superseding its prior evidence claim when the value changes.
Tool name: update_outcome_measurement. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.
Example prompt#
Update the outcome measurement.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| outcomeDefinitionId | string (UUID) | — | The reusable outcome definition this measures. |
| periodStart | string | null | — | First day (YYYY-MM-DD) of the period the reported value covers. |
| periodEnd | string | null | — | Last day (YYYY-MM-DD) of the period; must be on or after periodStart. |
| value | number | — | The reported outcome value, in the definition's value kind and unit. |
| baselineValue | unknown | — | Comparable value before the campaign, when the report supplied one. |
| market | string | null | — | Market or region the value applies to, for example "New Zealand". |
| sourceMethod | 'document_reported' | 'manual' | 'csv' | 'api' | — | How the value was obtained: document_reported, manual entry, csv import, or api. Reported outcomes are claims, not observed attribution. |
| confidence | number | null | — | Reporter's confidence in the value from 0 (none) to 1 (certain). |
| id | string (UUID) | Required | Unique identifier (UUID v4). |
What you'll get back#
Returns { data, _meta } with the result.
Delete outcome measurement#
Delete a reported campaign outcome measurement by soft deletion.
Tool name: delete_outcome_measurement. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.
Example prompt#
Delete this outcome measurement.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Unique identifier (UUID v4). |
What you'll get back#
Returns { data, _meta } with the result.