Insights#

Get intelligence and alerts about your organization to surface opportunities and risks.

Provider required

All hooks require a BrandwaveProvider ancestor in your component tree. See the React Hooks overview for setup instructions.

useListOrganizationInsights#

List intelligence insights and alerts for an organization. Returns a mix of positive intelligence (campaign outperformance, creator efficiency) and actionable alerts (stale metrics, data gaps).

typescript
import { useListOrganizationInsights } from '@brandwave/react';

const { data, isLoading } = useListOrganizationInsights({
  organizationId: 'org_123',
});

Parameters#

NameTypeRequiredDescription
organizationIdstring (UUID)RequiredOrganization identifier.

Response#

Returns { items, totalCount, facets } with paginated results.

Underlying SDK method: bw.insights.list(params)

useDismissInsight#

Update an insight to mark it dismissed so it is hidden from future list responses for the organization.

typescript
import { useDismissInsight } from '@brandwave/react';

const { mutate, isPending } = useDismissInsight();

mutate({
  insightId: '...',
});

Parameters#

NameTypeRequiredDescription
insightIdstring (UUID)RequiredInsight identifier to dismiss.

Response#

Returns { data } with the result.

Underlying SDK method: bw.insights.dismiss(params)