Conversions#
See how an AI assistant can help with conversions in Brandwave, including example prompts and the details it may ask for.
Using your AI assistant
Connect to the Brandwave MCP server, then ask your AI assistant in natural language. It will choose the right Brandwave task and ask for any details it needs.
List conversions#
List conversion events with pagination, search, and sorting.
Reads dataSafe to repeat
Example prompt#
text
List all conversions in my organization.Details to provide#
| 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. |
What you'll get back#
Returns { items, totalCount, facets } with paginated results.
Get conversion#
Retrieve a single conversion by ID.
Reads dataSafe to repeat
Example prompt#
text
Show me the details for this conversion.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Conversion identifier. |
What you'll get back#
Returns { data } with the result.
Create conversion#
Record a new conversion event attributed to a conversion source, with optional external reference for deduplication and metadata.
Example prompt#
text
Create a new conversion.Details to provide#
| 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). |
What you'll get back#
Returns { data } with the result.
Update conversion#
Update a conversion record, including its origin, external reference, metadata, and attribution details.
Example prompt#
text
Update the conversion.Details to provide#
| 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). |
What you'll get back#
Returns { data } with the result.