Activities#
See how an AI assistant can help with activities 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 activities#
Retrieve a paginated list of activities for an organization.
Reads dataSafe to repeat
Example prompt#
text
List all activities 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. |
| channel | 'instagram' | 'youtube' | 'tiktok' | 'twitter' | 'linkedin' | 'reddit' | — | Filter by social media platform. |
| creatorId | string (UUID) | — | Filter by creator identifier. |
| campaignId | string (UUID) | — | Filter by campaign identifier. |
What you'll get back#
Returns { items, totalCount, facets } with paginated results.
Count activities#
Get the total number of activities matching the given filters.
Reads dataSafe to repeat
Example prompt#
text
How many activities do I have?Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| channel | 'instagram' | 'youtube' | 'tiktok' | 'twitter' | 'linkedin' | 'reddit' | — | Filter by social media platform. |
| creatorId | string (UUID) | — | Filter by creator identifier. |
| campaignId | string (UUID) | — | Filter by campaign identifier. |
What you'll get back#
Returns { count } with the total number of matching records.
Get activity stats#
Aggregate statistics for activities matching the given filters.
Reads dataSafe to repeat
Example prompt#
text
Show me the details for this activity stats.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| channel | 'instagram' | 'youtube' | 'tiktok' | 'twitter' | 'linkedin' | 'reddit' | — | Filter by social media platform. |
| creatorId | string (UUID) | — | Filter by creator identifier. |
| campaignId | string (UUID) | — | Filter by campaign identifier. |
| searchTerm | string | — | Free-text search term to filter results (max 200 characters). |
What you'll get back#
Returns { data } with the result.
Create activity#
Create a new activity with optional creator auto-linking.
Example prompt#
text
Create a new activity.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| channel | 'instagram' | 'youtube' | 'tiktok' | 'twitter' | 'linkedin' | 'reddit' | Required | Social media platform for this activity. |
| activity | 'instagram_story' | 'instagram_post' | 'instagram_reel' | 'youtube_video' | 'youtube_short' | 'tiktok_video' | 'twitter_post' | 'linkedin_post' | 'reddit_post' | Required | Specific content type within a platform. |
| name | string | Required | Activity name or title (max 500 characters). |
| startAt | string (ISO 8601) | null | — | When the activity was published or started. |
| endAt | string (ISO 8601) | null | — | When the activity ended (e.g., story expiry). |
| creatorId | string (UUID) | — | Creator to auto-link to this activity. |
What you'll get back#
Returns { data } with the result.
Update activity#
Update an activity's details, social media channel, content link, or metrics.
Example prompt#
text
Update the activity.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Activity identifier to update. |
| channel | 'instagram' | 'youtube' | 'tiktok' | 'twitter' | 'linkedin' | 'reddit' | — | Updated social media platform. |
| activity | 'instagram_story' | 'instagram_post' | 'instagram_reel' | 'youtube_video' | 'youtube_short' | 'tiktok_video' | 'twitter_post' | 'linkedin_post' | 'reddit_post' | — | Updated content type. |
| name | string | Required | Updated activity name (max 500 characters). |
| startAt | string (ISO 8601) | null | — | Updated start date. |
| endAt | string (ISO 8601) | null | — | Updated end date. |
| contentHref | string (URL) | null | — | URL to the original content (max 2,048 characters). |
| viewsCount | integer | null | — | Manual view count override (non-negative integer). |
| likeCount | integer | null | — | Manual like count override (non-negative integer). |
| replyCount | integer | null | — | Manual reply count override (non-negative integer). |
What you'll get back#
Returns { data } with the result.
Content link changes reset metrics
Changing the contentLink triggers a metric refresh. Previous metric snapshots are preserved but the latest values will update.
Delete activity#
Permanently delete an activity and its associated records.
Changes data
Example prompt#
text
Delete this activity.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Activity identifier to delete. |
What you'll get back#
Returns { data } with the result.
This changes data
Deleting an activity permanently removes all linked metrics, costs, creator associations, and notes. This action cannot be undone.
Connect activity content link#
Connect a social media post URL to an activity for automatic metric tracking.
Example prompt#
text
Connect the activity content link.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| activityId | string (UUID) | Required | Activity identifier to connect the content link to. |
| platform | 'instagram' | 'youtube' | 'tiktok' | 'twitter' | 'linkedin' | 'reddit' | Required | Social media platform for this content. |
| contentUrl | string | Required | URL to the social media content (max 2,048 characters). |
What you'll get back#
Returns { data } with the result.
Metric refresh
Connecting a content link triggers an immediate metric fetch for the linked post.
Disconnect activity content link#
Disconnect a content link from an activity, stopping automatic metric tracking.
Example prompt#
text
Remove the activity content link.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| activityId | string (UUID) | Required | Activity identifier to disconnect the content link from. |
What you'll get back#
Returns { data } with the result.
List activity creators#
List creators linked to an activity with pagination.
Reads dataSafe to repeat
Example prompt#
text
List all activity creators 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) | Required | Activity identifier to list creators for. |
What you'll get back#
Returns { items, totalCount, facets } with paginated results.
Count activity creators#
Count the number of creators linked to an activity.
Reads dataSafe to repeat
Example prompt#
text
How many activity creators do I have?Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| activityId | string (UUID) | Required | Activity identifier to count creators for. |
What you'll get back#
Returns { count } with the total number of matching records.
Link activity creator#
Associate a creator with an activity.
Example prompt#
text
Connect the activity creator.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| activityId | string (UUID) | Required | Activity identifier to link. |
| creatorId | string (UUID) | Required | Creator identifier to link. |
What you'll get back#
Returns { data } with the result.
Unlink activity creator#
Remove a creator association from an activity.
Changes data
Example prompt#
text
Remove the activity creator.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| activityId | string (UUID) | Required | Activity identifier to unlink from. |
| creatorId | string (UUID) | Required | Creator identifier to unlink. |
What you'll get back#
Returns { data } with the result.
Cascading deletion
Unlinking a creator removes all cost records associated with that creator on this activity.
Create activity cost#
Add a cost line item to an activity with amount and currency code.
Example prompt#
text
Create a new activity cost.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| activityId | string (UUID) | Required | Activity identifier to add the cost to. |
| amount | number | Required | Cost amount (must be greater than zero, max 100M). |
| type | string | Required | Cost type label, e.g. "creator_fee", "production" (max 100 characters). |
| currency | string | Required | ISO 4217 currency code, e.g. "USD", "NZD" (exactly 3 characters). |
| description | string | null | — | Optional description of this cost line item (max 1,000 characters). |
| creatorId | string (UUID) | null | — | Creator this cost is attributed to. |
What you'll get back#
Returns { data } with the result.
Auto-linking
If the activity has exactly one linked creator, the cost is automatically attributed to that creator.
Update activity cost#
Update a cost line item on an activity, including creator attribution.
Example prompt#
text
Update the activity cost.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Cost record identifier to update. |
| amount | number | — | Updated cost amount (must be greater than zero, max 100M). |
| type | string | — | Updated cost type label (max 100 characters). |
| description | string | null | — | Updated description (max 1,000 characters). |
| creatorId | string (UUID) | null | — | Updated creator attribution. |
What you'll get back#
Returns { data } with the result.
Delete activity cost#
Remove a cost line item from an activity.
Changes data
Example prompt#
text
Delete this activity cost.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Cost record identifier to delete. |
What you'll get back#
Returns { data } with the result.
Get metric confidence#
Assess the statistical confidence of an activity's metrics.
Reads dataSafe to repeat
Example prompt#
text
Show me the details for this metric confidence.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| startDate | string | null | — | Start date for confidence calculation window. |
| endDate | string | null | — | End date for confidence calculation window. |
What you'll get back#
Returns { data } with the result.
List sparklines#
Fetch sparkline chart data for one or more activities.
Reads dataSafe to repeat
Example prompt#
text
List all sparklines in my organization.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| activityIds | Array<string (UUID)> | Required | Array of activity identifiers to fetch sparkline data for. |
What you'll get back#
Returns { items, totalCount, facets } with paginated results.