Insights#

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

List organization insights#

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
const { items, totalCount, facets } = await bw.insights.list({
  organizationId: 'org_123',
});

Parameters#

NameTypeRequiredDescription
organizationIdstring (UUID)RequiredOrganization identifier.

Response#

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

Dismiss insight#

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

typescript
const { data } = await bw.insights.dismiss({
  insightId: '...',
});

Parameters#

NameTypeRequiredDescription
insightIdstring (UUID)RequiredInsight identifier to dismiss.

Response#

Returns { data } with the result.