Success metrics#

Manage the GA4 events an organization tracks as success metrics for reporting.

List success metrics#

List the organization's selected success metrics — the GA4 events it defines as success (e.g. sign-ups, purchases).

typescript

const { items, totalCount, facets } = await bw.successMetrics.list({
  organizationId: '1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01',
});

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.

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

Add one or more success metrics. Historical event data is backfilled from Google Analytics automatically.

Owner only

typescript

const { data } = await bw.successMetrics.add({
  organizationId: '1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01',
  metrics: '...',
});

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
metrics	`Array<object>`	Required	Success metrics to add (1-50).

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

Remove a success metric and purge its synced event data.

Owner only

typescript

const { data } = await bw.successMetrics.remove({
  organizationId: '1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01',
  successMetricId: '...',
});

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
successMetricId	`string (UUID)`	Required	Success metric identifier to remove.

Returns { data } with the result.