variants

How this variant's sales have moved when its price moved

What past price changes did to this variant's sales velocity, as a tier with the evidence behind it.

tier is HIGH, MODERATE, LOW, INCONSISTENT, STILL_LEARNING or null. confidence, n_events (the qualifying price changes counted), sign_agreement, shrunk_effect_up and shrunk_effect_down (the effect of a rise and of a cut, as signed fractions) and data_through (the last event analysed) are the figures under it. worth_considering and summary are those figures written as sentences.

A variant with no classification yet answers every field null with n_events: 0. That is the honest answer, not an error, and not a tier of zero. An id no variant has answers the same shape rather than a refusal, so this read cannot tell you an id is wrong. Check it against a variant read.

basis and the fields beside it say why a tier is what it is: periods_observed, price_variation against required_price_variation, expected_error, and a reference_elasticity with its reference_basis and reference_source where the variant's own history is too thin. A tier of STILL_LEARNING with a price_variation well under required_price_variation means the price has not moved enough to measure, not that the reading is pending.

engine names the run behind the tier: state is not_run, current, borrowed or insufficient, the figure's state and never a run's, with computed_at (the run's, never your clock), inputs_through, stale_after, basis and run_id.

Scope: products:read.

get/api/v1/variants/{variant_id}/price-sensitivity

Request

  • Base URL: https://api.app.tightly.io
  • URL: https://api.app.tightly.io/api/v1/variants/{variant_id}/price-sensitivity
  • Auth: HTTP bearer

Path parameters

variant_idstring required
Example:42318902722609

The variant this reads.

Headers

Tightly-Versionstring
Example:2026-11

The date train to answer on. One train exists today, 2026-11, the one this reference describes and the one every key is minted on, so the call answers on it with or without this header. Send it anyway, so a client built now names its train from the start.

Response

The tier, the figures under it, and the sentences they make.

messageobject

severity, service and desc.

Changes

No recorded changes to this operation across all 1 revision of this API.