Skip to documentation
Browse documentation
API reference / BOM history
GET/v1/bom/yield-changesbom:read

Compare BOM yield snapshots

Operation ID: listBomYieldChanges

Parameters

NameLocationTypeDescription
cursorquerystringOpaque cursor returned by links.next.
limitqueryintegerPage size.
fromquerystring dateSelect the latest completed snapshot at or before this date.
toquerystring dateSelect the latest completed snapshot at or before this date.
fromSnapshotIdquerystringExplicit prior snapshot ULID.
toSnapshotIdquerystringExplicit current snapshot ULID.
skuquerystringExact SKU filter.
stylequerystringExact style filter.
mpnquerystringExact MPN filter.
supplierquerystringExact supplier filter.
changeTypequeryadded | removed | changed | unchangedAllowlisted change classification.
includeUnchangedquerybooleanInclude unchanged rows.

Example request

curl --request GET \
  --url 'https://api.data.hyran.co/v1/bom/yield-changes?from=2026-07-31&to=2026-08-31&changeType=changed&limit=100' \
  --header "Authorization: Bearer $HYRAN_DATA_API_TOKEN" \
  --header "Accept: application/json"

Responses

HTTP 200

Successful response

HTTP 400

Problem response

HTTP 401

Problem response

HTTP 403

Problem response

HTTP 404

Problem response

HTTP 409

Problem response

HTTP 429

Problem response

HTTP 500

Problem response

HTTP 503

Problem response

Try this operation

The credential is held only in React memory for this browser tab. Hyran Docs does not persist, proxy, inspect, or log it.