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 an organization.
Tool name: list_outcome_definitions. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt#
List all outcome definitions 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.
Create outcome definition#
Create a reusable definition for a reported business or brand outcome such as sales value, awareness, or qualified enquiries.
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 |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| name | string | Required | |
| description | string | null | — | |
| valueKind | 'count' | 'currency' | 'percentage' | 'ratio' | 'index' | 'duration' | 'other' | Required | |
| unitLabel | string | null | — | |
| defaultCurrency | string | null | — |
What you'll get back#
Returns { data, _meta } with the result.
Update outcome definition#
Update 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 | — | |
| description | string | null | — | |
| valueKind | 'count' | 'currency' | 'percentage' | 'ratio' | 'index' | 'duration' | 'other' | — | |
| unitLabel | string | null | — | |
| defaultCurrency | string | null | — | |
| 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 organization.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization 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#
Create a campaign-reported outcome measurement with an explicit source method and 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 |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| campaignId | string (UUID) | Required | Unique identifier (UUID v4). |
| outcomeDefinitionId | string (UUID) | Required | Unique identifier (UUID v4). |
| periodStart | string | null | — | |
| periodEnd | string | null | — | |
| value | number | Required | |
| baselineValue | number | null | — | |
| market | string | null | — | |
| sourceMethod | 'document_reported' | 'manual' | 'csv' | 'api' | Required | |
| confidence | number | null | — |
What you'll get back#
Returns { data, _meta } with the result.
Update outcome measurement#
Update a reported outcome measurement and supersede its prior active 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) | — | Unique identifier (UUID v4). |
| periodStart | string | null | — | |
| periodEnd | string | null | — | |
| value | number | — | |
| baselineValue | number | null | — | |
| market | string | null | — | |
| sourceMethod | 'document_reported' | 'manual' | 'csv' | 'api' | — | |
| confidence | number | null | — | |
| 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.