Costs#
See how an AI assistant can help with costs in Brandwave, including example prompts and the details it may ask for.
Using your AI assistant
List costs#
List cost records across activities, including creator details, with global amount or creation-date sorting before pagination.
Tool name: list_costs. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt#
List all costs 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. |
| activityId | string (UUID) | — | Filter by activity identifier. |
| creatorId | string (UUID) | — | Filter by creator identifier. |
| campaignId | string (UUID) | — | Filter by campaign identifier. |
| searchTerm | string | — | Search cost category, description, or activity name. |
| categoryId | string (UUID) | — | Filter by cost category identifier. |
| sortBy | 'amount' | 'createdAt' | — | Cost field to sort by. |
| sortDirection | 'asc' | 'desc' | — | Sort direction: ascending or descending. |
What you'll get back#
Returns { items, totalCount, facets, _meta } with paginated results.
Count costs#
Count cost records with optional activity and creator filters.
Tool name: count_costs. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt#
How many costs do I have?Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| activityId | string (UUID) | — | Filter by activity identifier. |
| creatorId | string (UUID) | — | Filter by creator identifier. |
| campaignId | string (UUID) | — | Filter by campaign identifier. |
What you'll get back#
Returns { count, _meta }.
Get cost stats#
Aggregate total spend, cost coverage, non-campaign spend, and largest category using the active cost filters.
Tool name: get_cost_stats. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt#
Show me the details for this cost stats.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| activityId | string (UUID) | — | Unique identifier (UUID v4). |
| creatorId | string (UUID) | — | Unique identifier (UUID v4). |
| campaignId | string (UUID) | — | Unique identifier (UUID v4). |
| searchTerm | string | — | |
| categoryId | string (UUID) | — | Unique identifier (UUID v4). |
What you'll get back#
Returns { data, _meta } with the result.