Documentation menu
Integrations and API // 01

Kiosk events

The anonymous events a store's screens send to head office, what each means, what it drives, how they are batched, and what is never in them.

As shoppers use the screens, each screen records anonymous events and sends them to head office. Events drive insights, lost demand, trend velocity, concept votes, fit learning, the sales loop and device health. No event carries a name, contact, face or photo.

Sending events

POST /api/launch/v1/retail/events
Authorization: Bearer <kiosk key>
{ "batchId": "…", "events": [ … ] }
  • Up to 500 events or 256 KB per batch, and 20 batches a minute per key.
  • A batch sent twice is stored once.
  • Each event's time must carry a time zone, be no more than seven days old, and no more than five minutes ahead.
  • Ateliq's screens send a batch every 30 seconds, or sooner when 200 events are waiting, and retry with growing gaps (5 seconds, 30 seconds, 2 minutes, then every 10 minutes). Events not sent within 24 hours are dropped.

Event types

EventSent whenCarries
visitA visit startsAn anonymous visit id
tryonA piece is tried onThe product and, when known, the size label
look_mainA look is built around a pieceThe product
acceptThe shopper adds a suggested add-on or step-upThe product
decidedThe shopper picks one after a side-by-sideThe product
viewA piece is viewedThe product
missA search finds nothingThe phrase, up to 80 characters. Phrases that look like an email address or phone number are dropped.
size_outA size the shopper wanted is out of stockThe product and size
size_suggestedThe stylist shows or says a sizeThe suggested size or sizes, evidence, confidence, chart and source. Never the shopper's own stated size, brand or fit preference.
offer_shownA live offer is shownThe offer id
voteA shopper votes on a design conceptUp or down
purchaseA purchase completes on the screenTotal, discount, currency and products
stylist_callA shopper calls a stylistThe call id. Never the shopper's note.
stylist_answeredAn associate answersThe call id, the associate's code and the wait in seconds
heartbeatEvery minuteFeed version, app version, feed age, events waiting, and up to eight screens' layout, camera and voice

What they drive

FeatureEvents
Insightsvisit, tryon, look_main, purchase, offer_shown, miss
Lost demandmiss, size_out
Trend velocitytryon
Concept talliestryon, vote
Sales loopstylist_call, stylist_answered
Fit learningtryon sizes, joined to paid hand-offs
Devicesheartbeat
The agentsmiss, tryon, purchase (as counts and screened phrases)

Offline

When a store's connection drops, visits, try-ons and concept votes queue on the screen (up to 500 events or 24 hours) and are sent with their original times when it returns. See Offline behaviour.

Kiosk events are kept for 400 days. See Data retention.

Something missing or unclear? Write to pb@ateliq.co and we will answer and fix this page. Last reviewed 12 November 2026.