Reference

Limits

Request sizes, batch sizes and the other fixed bounds of the gateway and the SDKs.

The fixed bounds of the gateway and the SDKs. Each one keeps a busy site, a misbehaving client or a flood from costing more than it should, and each is enforced in code, not only documented.

Gateway endpoints

EndpointUsed byRequest body, at mostOther bounds
POST /v1/bThe browser part, the Shopify pixel32 KBPublic key; page and origin must be on the site's domain
POST /v1/rThe recorder2 MB40 chunks and 5 MB of recorded data per visit; no chunks for a visit idle for more than 35 minutes
POST /v1/sThe server part, orders, UCP reports256 KB100 events per request (events after the first 100 are ignored); meta.dropped a whole number from 0 to 1,000,000
GET /v1/statsScripts, with a "Send + read" keydays from 1 to 90
POST /v1/auditsScripts, with a "Send + read" key4 KBPages on the site's own, verified domain only

A site stores at most 4,000 recording chunks, and 300 MiB of stored (compressed) recording data, in any 24 hours.

Rate limits. Every endpoint is rate-limited per client address, and /v1/s per key as well. A request over a limit gets 429 with {"error":"Too many requests"} or {"error":"Too many requests for this key"}, and no Retry-After header. Nothing in it was written, so it can be sent again later; @parlox/server does that for its batches.

Answers. The gateway answers only once the database has confirmed the write; 503 means it did not confirm it. The browser part resends an unconfirmed beacon, and the gateway drops one it already has. @parlox/server does not resend a batch after a 503, since it may have been stored, and counts it as not confirmed instead. A beacon with an unknown key, or from a page outside the site's domain, is answered 204 and not stored.

Values the gateway keeps

FieldKept as
value (browser), value_cents (server)Cents, a whole number from 0 to 100,000,000,000
currencyThree capital letters, else dropped
itemsA whole number
order_id, item_idText, cut to 64 characters
stepLowercase letters and underscores, up to 20 characters, else dropped
A visit id (sid)16 to 32 lowercase hexadecimal characters, else not joined to a visit

The browser part

BoundValue
Visit id lifetime30 minutes with no activity, in one tab
Outbox of unanswered beacons30 beacons, 10 minutes, 4 attempts each
Events waiting on one page100 at a time, 500 per page
track() calls queued before Parlox starts (before init, or in the tag's stub)100; a consent decision in the stub is never dropped
Data-layer messages held before the page opens50
A click's label60 characters, masked
A clicked control's accessible name80 characters, masked (up to 1.0.3 it could carry a wrapped block's text: Masking)
Fields in a page's friction summary30
Recording, per visit30 minutes, 40 chunks, 5 MB

The server part

BoundValue
A report or an order sent on its ownGives up after 2 seconds (timeoutMs)
A batch (long-running servers)100 reports, 200,000 bytes, 10 seconds; one request at a time
The queue (long-running servers)1,000 reports; when full, the oldest is dropped and counted
Reports sent at once in a process64; the excess is counted, not sent
Orders posted at the same time10 (maxPurchasesInFlight)
UCP reports posted at the same time10, apart from orders (maxUcpReportsInFlight)
RetriesOnly a batch Parlox provably did not store: 3 more attempts, 3 seconds apart or after Retry-After (at most 60 seconds)
flush()30 seconds by default
A report's fieldsPath 2,000 characters, user agent 1,000, Referer 2,000

Keys

BoundValue
Active secret keys per site20
A key's name1 to 80 characters
A key's noteUp to 200 characters
Grace period when replacing a keyNone, 24 hours or 7 days