Skip to documentation
Browse documentation

Compare completed BOM yield snapshots

Hyran Data preserves immutable BOM publication snapshots. It records source time, ingestion time, prior and current values, provenance, and versioned SKU-to-material relationships. Normal Brand uploads replace transactional BOM rows, but Hyran Data publications preserve the historical timeline.

Choose snapshots

GET /v1/bom/snapshots lists completed snapshots. Partially delivered publications never appear as completed history.

For yield changes, choose one of two comparison modes:

  1. Supply from and to dates. Hyran Data selects the latest completed snapshot at or before each date.
  2. Supply fromSnapshotId and toSnapshotId to compare exact immutable snapshots.

Do not combine date and snapshot selection for the same side of a comparison.

Read yield changes

curl --get https://api.data.hyran.co/v1/bom/yield-changes \
  --header "Authorization: Bearer $HYRAN_DATA_API_TOKEN" \
  --data-urlencode "from=2026-07-31" \
  --data-urlencode "to=2026-08-31" \
  --data-urlencode "changeType=changed" \
  --data-urlencode "limit=1000"

Each row includes SKU, style, MPN, material color, body-part location, supplier, UOM, prior yield, current yield, absolute delta, percentage delta, change type, and snapshot provenance.

Change types

Change typeInterpretation
addedThe current snapshot contains the relationship and the prior snapshot does not
removedThe prior snapshot contains the relationship and the current snapshot does not
changedBoth snapshots contain the relationship with a meaningful yield difference
unchangedBoth snapshots contain an equivalent yield, returned only when requested