conversions#
Browse conversions resource actions that can be discovered, described, and executed through the Brandwave MCP server.
Capability flow
discover-brandwave-capabilities, describe-brandwave-action, and execute-brandwave-action to work with these actions.list-conversions#
List conversion events with pagination, search, and sorting.
Example prompt#
List all conversions in my organization.Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| pageIndex | integer | Required | Zero-based page index for pagination. |
| pageSize | integer | Required | Number of items per page (1-100). |
| organizationId | string (UUID) | Required | Organization identifier. |
| searchTerm | string | — | Free-text search term to filter results (max 200 characters). |
| sortBy | string | — | Column name to sort by. |
| sortDirection | 'asc' | 'desc' | — | Sort direction: ascending or descending. |
| sourceId | string (UUID) | — | Filter by conversion source identifier. |
Response#
Returns { items, totalCount, facets } with paginated results.
Underlying SDK method: bw.conversions.list(params)
get-conversion#
Retrieve a single conversion by ID.
Example prompt#
Show me the details for this conversion.Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Conversion identifier. |
Response#
Returns { data } with the result.
Underlying SDK method: bw.conversions({ id })
create-conversion#
Record a new conversion event attributed to a conversion source, with optional external reference for deduplication and metadata.
Example prompt#
Create a new conversion.Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| sourceId | string (UUID) | Required | Conversion source this event is attributed to. |
| convertedAt | string (ISO 8601) | Required | When the conversion occurred. |
| count | integer | — | Number of conversions in this event (must be greater than zero, defaults to 1, max 1M). |
| origin | string | — | Origin or channel of the conversion, e.g. "website", "app" (max 50 characters). |
| externalRef | string | — | External reference identifier for deduplication (max 255 characters). |
| metadata | object | — | Arbitrary key-value metadata (max 50 keys, keys max 64 characters). |
Response#
Returns { data } with the result.
Underlying SDK method: bw.conversions.create(params)
update-conversion#
Update a conversion record, including its origin, external reference, metadata, and attribution details.
Example prompt#
Update the conversion.Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Conversion identifier to update. |
| sourceId | string (UUID) | — | Updated conversion source. |
| convertedAt | string (ISO 8601) | — | Updated conversion timestamp. |
| count | integer | — | Updated conversion count (must be greater than zero, max 1M). |
| origin | string | — | Updated origin (max 50 characters). |
| externalRef | string | null | — | Updated external reference (max 255 characters). |
| metadata | object | null | — | Updated metadata (max 50 keys, keys max 64 characters). |
Response#
Returns { data } with the result.
Underlying SDK method: bw.conversions.update(params)