Get holiday benchmark snapshot

Retrieve a seasonal event benchmarking snapshot (Holiday Index and Brand Benchmark) for a shopping event such as BFCM or Labor Day.

Returns a single KPI object summarizing the brand's performance across the requested window. To match the Intelligems dashboard's "Q4 to Date" tile, pass Oct 1 → Dec 31 of the event year. For time-indexed chart data across the event window, use POST /analytics/event/timeseries.

Enumerations

event — the seasonal event identifier:

• "BFCM" — Black Friday / Cyber Monday
• "laborDay"
• "memorialDay"
• "presidentsDay"

metric — the KPI to return:

• "revenue" — net revenue
• "orders" — order count
• "priceLevels" — average unit price

Request

Response

{
  "currency": "USD",
  "snapshot": {
    "periodToDateValue": 125000.5,
    "vsLastYear": 0.12,
    "avgDailyIndexPercent": 1.27,
    "currentIndexPercent": 1.23
  }
}

• periodToDateValue — brand actual value for the selected metric across the event window. Maps to the dashboard's "Q4 {Metric} to Date" tile.
• vsLastYear — percent change vs. the same period in the prior event year (e.g. 0.12 = +12%). Maps to the ±% pill on the "Q4 to Date" tile.
• avgDailyIndexPercent — the brand's average daily value as a percent of its own full-day baseline, across the window. Maps to the dashboard's "Avg Daily {Metric} (% of typical day)" tile.
• currentIndexPercent — the industry-wide average daily index across the window (percent of full-day baseline, aggregated across the ~1,000-brand basket). Maps to the dashboard's "Index (% of typical day)" tile.

All numeric fields are number | null.

Rate limits

Uses the same rate limit as the /analytics/sitewide/* endpoints. Aggregated, cacheable data — see the Rate Limiting Reference.

Rate Limit: 10 requests per 30s window, refilling 5 tokens every 30s.