Skip to main content
Boom does not decide what a good outcome is for you. You define it, per initiative, and everything else is measured against that definition: a rate, a value, a funnel, and the list of individual conversations that counted.
Success metrics can be configured from the app or over the API and MCP. The analytics views — the funnel, the per node numbers, the charts — are read in the app only. The raw material behind them is on the API: extracted values, transcripts and participant records all come back, so you can compute your own numbers if you would rather.
Success metrics measure one initiative at a time. For one number across your whole company, where each sale is credited to a single initiative, see Home and attributed revenue. A metric on your sale reads that same number: see Sales metrics read Home.

Defining success

An initiative can carry more than one named success metric. Each one says what signal counts as success, and how to aggregate it. Three kinds of signal: Each metric aggregates as a count, a sum, an average or a max, so “how many came back” and “how much revenue came back” are the same mechanism with a different aggregation.

The attribution window

A conversation’s window opens at the first message Boom actually sent (a message that failed or is still pending doesn’t count) and closes 48 hours after the journey ends. That grace period is fixed and not configurable today, so a purchase two weeks later is not attributed, by design. A person Boom never messaged has no window at all, and is excluded from both the numerator and the denominator rather than counted as a failure.

Sales metrics read Home

Once Home has matched your workspace’s history, a metric on your sale (the same CDP event, or the same CDP object type, as your workspace’s main conversion) no longer matches on its own. It reads the sales Home credited to this initiative, so the initiative page and Home add up the same revenue. That changes a few things:
  • Each sale counts once, for one initiative: the one whose message came last before the purchase. A sale two initiatives were both in touch about counts for only one of them, so an initiative’s total can be lower than before.
  • The sale is valued and filtered as your main conversion says, whatever value property the metric names (for example, cancelled or refunded orders are left out), inside the conversion’s window rather than the 48 hours above.
  • A conversation that led to two purchases is one success, worth both. The success rate stays the share of messaged people who bought.
  • Influenced sales appear next to the number: sales another initiative took while this one was also in touch. They are counted for the whole initiative, not per version or environment.
  • One currency is added up: the one with most of the initiative’s sales, as Home leads with it. A sale in another currency, or one with no amount, counts as a success with no value.
Some metrics keep matching on their own: one narrowed by a filter of its own (premium plans only, say), which Home’s credits can’t apply, an initiative that doesn’t earn sales credit (set to Never, a survey, or a post-purchase flow) and the test environment, for which Home has no credits to read. Metrics on anything else (a booked demo, a survey answer, an extracted variable) keep working as described on this page. The initiative page shows one environment and journey runs at a time, while Home counts every run outside test, so the two match for the same environment and period.

Configuring metrics over the API

The same definitions the app’s dialog writes are readable and settable programmatically, on an initiative you already have the id for.
  • success_metrics_catalog — what a metric can point at
  • success_metrics_list — the metrics on an initiative
  • success_metrics_upsert — add one, or replace one by rootId
  • success_metrics_delete — retire one

Start with the catalog

An event name, object type or variable that does not exist is accepted and then matches nothing, so the metric quietly reports zero rather than failing. Ask what is available first:
You get events, objectTypes and variables for this initiative (variables leaves out archived guiding questions, which collect no new answers). Add ?eventName=order_completed for that event’s properties, or ?objectTypeId=... for a type’s attributes and the paths that link it to a person; both come back null when you did not ask for them.

Setting a metric

Abridged: the response always carries every configuration field, null for the ones this signal type does not use. Omit rootId to add a metric; pass an existing metric’s rootId to replace it, which files a new version under the same rootId. rootId is the id to hold on to — version counts the initiative’s definition history, not this metric’s, so a brand new metric on an initiative that already has one starts above 1. Replacing is not a patch — send the metric’s complete configuration, because fields you leave out are cleared rather than kept. Which fields are required depends on signalType and aggregation: a COUNT needs no value field, while SUM, AVERAGE and MAX each need one, and a missing one is rejected with a validation_failed error naming the field. GET /api/v1/initiatives/{id}/success-metrics returns the metrics in the exact shape POST accepts, so you can read one, change a field and send it back. It returns the ACTIVE ones by default; ?status=all adds the superseded versions, newest first, which is the edit history. An initiative with nothing configured returns an empty list, not a 404.

Retiring a metric

The metric leaves the dashboard immediately. Its configuration is kept for the audit trail — ?status=all still lists it as SUPERSEDED — and posting the same rootId again brings it back. Removing the last metric returns the initiative to having no success measure, which is a normal state.
Both writes are retroactive. Successes are recomputed on every read against the current definition, so editing a metric changes what past periods report and deleting one removes the numbers it reported for earlier conversations too. Nothing is pinned per period.
Over MCP, setting and deleting require a role that can edit initiatives (Owner, Admin or Member); listing and the catalog work for any role that can see initiatives. Over REST all four take a valid organization API key, and any valid key can make any of these calls: treat a key as full access to your organization and scope who holds it accordingly.
An initiative is capped at ten ACTIVE metrics over this surface. Past that, POST is refused until you retire one or pass its rootId to replace it.

What you get

Per node, from the messages themselves with nothing to configure: sent, delivered, read and replied counts, how each branch split, and median wait times. Useful for finding the step where people fall out. A funnel that starts at Sent rather than at enrolled, with each stage showing its share of the previous stage and of the first, ending in a shared succeeded stage. A success rate whose denominator is the people Boom actually messaged, not everyone who entered. Worth knowing before comparing it to a number from another tool, which may well count differently. Successes over time, bucketed by day, switchable between count and value when the metric aggregates a value. The evidence behind the number: the individual successes that matched (for a sales metric that reads Home, the credited sales), each linking to that participant and to the run that produced it. This is the part people ask for when they do not believe the dashboard. ROI, if you turn it on for the metric (roiEnabled): the attributed sales over what the journey’s messages cost, in US dollars. The cost side is a fixed average per message — not your invoice — so read it as an order of magnitude, not as billing. It is off by default, only offered on a metric that sums a money value, and sales reported in pesos are converted at a fixed rate.
Metrics are recomputed on read against the current definition (a sales metric that reads Home follows your main conversion instead), and editing a definition creates a new version rather than pinning history. So changing what counts as success also changes what past periods show. Decide the definition before you need to defend a number with it.

Reading the raw data instead

Everything the dashboard builds on is available over the API and MCP, covered in extraction:
  • the aggregate summary for an initiative, with coverage and distributions per field
  • each participant’s extracted values, including the quote the value came from and a confidence
  • full transcripts, in batches, so you can pull every conversation without looping one at a time
  • the step by step run timeline for a participant, when you need to know what the engine did rather than what was said
CSV and XLSX exports live in the app, including one row per participant with one column per extracted field.

What this is not

There is no experiment primitive: no randomized allocation, no significance testing. You can compare variants by branching a journey on an attribute and reading each path’s success metric, which answers most questions, but the split is deterministic and the statistics are yours to do. There is no warehouse sync. Bulk reads are polling. Outbound webhooks do exist for journey-run lifecycle events, and are the exception to “reads are polling”: Boom can POST to an endpoint you own when a run starts, when a run ends (with the reason it ended), and when someone matched a trigger but was not enrolled. They are enabled per organization, so talk to us if you want them switched on.

Extraction

The typed fields a conversation yields, and the read paths behind these numbers.

Journeys

The flow whose nodes these per step metrics describe.

Events

Record the events a success metric can watch for.

Initiatives

The mission a success metric belongs to.