Success metrics#

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

Authentication required

All endpoints require a Bearer token in the Authorization header. See the Authentication guide for setup instructions.

GET /v1/success-metrics#

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

bash

GET /v1/success-metrics?organization_id=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01
Authorization: Bearer {token}

Parameters#

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

Response#

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

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

POST /v1/success-metrics#

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

Owner only

bash

POST /v1/success-metrics
Authorization: Bearer {token}
Content-Type: application/json

{
  "organization_id": "1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01",
  "metrics": "..."
}

Parameters#

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

Response#

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

Underlying SDK method: bw.successMetrics.add(params)

DELETE /v1/success-metrics/:id#

Remove a success metric and purge its synced event data.

Owner only

bash

DELETE /v1/success-metrics/:id
Authorization: Bearer {token}
Content-Type: application/json

{
  "organization_id": "1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01",
  "success_metric_id": "..."
}

Parameters#

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

Response#

Returns { data } with the result.

Underlying SDK method: bw.successMetrics.remove(params)