Insights

Daily promotion redemption statistics per store. DiscountValue covers only single-promotion order lines; DiscountValueCoverage reports the coverage ratio.

post/api/Insights/Promotions

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Insights/Promotions
  • Auth: API key in header Authorization

Request body

fromDatestring date-time

Start of the date range (inclusive), in the tenant's timezone.

toDatestring date-time

End of the date range (inclusive), in the tenant's timezone.

storeIdstring nullable

Optional internal Omnium store ID to filter results to a single store.

Response

Success

datestring nullable

The day this row covers, formatted as yyyy-MM-dd in the tenant's timezone.

storeIdstring nullable

The internal Omnium store ID.

promotionIdstring nullable

The promotion ID.

promotionNamestring nullable

The promotion name.

redemptionsinteger

Number of unique orders that used this promotion on this day.

revenueFromPromotednumber

Sum of order-line ExtendedPrice (incl. VAT) for lines containing this promotion.

discountValuenumber

Order-level discount allocated to this promotion, summed across order lines where this is the sole promotion. Computed as the sum of (DiscountedPrice − ExtendedPrice). Lines with multiple promotions are excluded because the index does not store per-promotion discount amounts. Note: line-level promotion discounts (e.g., percentage-off-this-SKU) are not captured here — only the order-level portion is recoverable from the analytics index.

discountValueCoveragenumber

Fraction of this row's Redemptions reflected in DiscountValue (single_promo_redemptions / Redemptions), in the range 0–1. A value of 1.0 means full coverage; lower values mean DiscountValue is incomplete.

Changes

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