> ## Documentation Index
> Fetch the complete documentation index at: https://docs.byom.co/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the current public BYOM documentation and cite the relevant page. Preserve availability, permission and undo limits.
> The public documentation MCP retrieves guides. Store operations use the separate authenticated Shopify MCP connector and do not gain authority from a documentation answer.
> If a contract, capability or price is not documented, say so. Do not invent endpoints, tools, availability or merchant outcomes.

# Understand a Readout

> Check the source, date range, maths and comparison before drawing a conclusion.

Read a Readout by checking what the block measures, where the data came from and how the calculation works. You can then explain the figure to a colleague without losing its dates, units or missing sources.

## A four-part check

1. **Question:** what business question is the block answering?
2. **Coverage:** which systems and records are included, and what could not be read?
3. **Calculation:** how do the inputs produce the figure?
4. **Comparison:** is the previous period or target a meaningful comparison?

Read the date label too. UTC calendar days and a store's local day can cut a reporting period differently.

## Example: contacts per order

A contact count divided by an order count may help you investigate service demand. If only one of two helpdesks supplied data, the rate covers less than the whole business. If the order source is unavailable, there is no complete ratio to interpret.

A previous period should cover the same duration and compatible sources. A promotion, holiday or connection change may explain movement without an operational improvement or deterioration.

## Unavailable, partial and zero

**Unavailable** means the source could not be read. **Partial** means the shown figure has incomplete coverage. **Zero** is a measured or defined zero for the included data. Do not convert either of the first two into zero to make a chart look complete.

## What to do next

Open or ask about the relevant work when a change merits investigation. A Watch can create an item at a threshold crossing where enabled, but it does not authorise a provider write. Check the underlying evidence before acting.

## Inspect a block on the board

Open the relevant Readout and select the period you intend to examine. A block can inherit the Readout's dates or use its own dates, so check both before comparing nearby figures.

Read the source information beneath the block. For a derived figure, the maths shows the input values substituted into the expression. The definition information control explains the metric and its included records or exclusions. A block with one direct input may show its source without a calculation.

If you are allowed to edit the block, open its editor to inspect **Data points**, the expression, **Unit**, **Compare with**, **Bad news is when it goes** and **Dates**. Do not save a change merely to understand the existing calculation. A viewer should use the displayed source and definition information instead.

## Worked interpretation: contact rate moved

Suppose a fictional Readout shows 120 contacts and 1,000 orders for one period. A calculation of contacts divided by orders, multiplied by 100, yields 12 contacts per 100 orders. The previous equal-length period shows 10.

That is a rise of 2 contacts per 100 orders. It is also a 20% relative rise from 10 to 12. Those are different statements; neither should be described vaguely as “up 2%”. Read the unit and comparison before sharing the result.

Now suppose one helpdesk failed to supply data in the earlier period. The numerical movement is still visible, but the periods do not cover the same sources. It cannot establish a company-wide increase in contact demand until the coverage difference is resolved.

Finally, suppose the current order source is unavailable. The system cannot establish the complete ratio. Treat the missing source as an access or data problem, not as evidence that orders fell to zero.

## Check a threshold alert

Where available, a block's Watch is configured under **Tell me when it goes**. Inspect the threshold and whether it is Above or Below. A change in units can change the meaning of the same numerical threshold, so read them together.

A crossing opens work to inspect. Remaining above the line does not need a new alert each time, and unavailable data is not a numerical crossing. Investigate the source and situation before preparing any external response.

## Explain the result to a colleague

Include the figure, unit, dates, sources and material coverage limitations. For example: “The included sources show 12 contacts per 100 orders over these UTC days; the earlier period is incomplete because a helpdesk feed was missing.”

That gives a colleague enough context to use the result without turning it into a stronger claim. If the question concerns money or performance, check that the input definition measures that outcome rather than a forecast or modelled estimate.

Reviewed 2 October 2026.

## Related guides

* [Readouts](/product/readouts)
* [Integrations](/product/connections)
* [HQ and Workspace](/product/hq-workspace)


## Related topics

- [Readouts](/product/readouts.md)
- [The BYOM field guide](/index.md)
- [What is BYOM?](/start/what-is-byom.md)
- [Rails](/product/rails.md)
- [Data and access](/trust/data-and-access.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.