Custom API
Partner commerce insights & privacy
Reference only. Not a decision unless cited in product/DECISIONS.md.
Partner commerce insights & privacy
How AXYN measures ticket-page conversion on partner surfaces (Web SDK embed; optional headless commerce pixel when enabled and installed), what we may collect, what we never collect, and how partners disclose it to visitors.
This is organizer Sales analytics (impressions / funnel SoR). It is not PostHog (AXYN’s own product analytics) and not Meta/Google ad pixels.
Related: Checkout attribution, Headless API, Credentials, public policy at axyn.events/legal/privacy.
Locked decisions (PIE gate — 2026-08-03; keyless install — ENG-635)
| # | Question | Decision |
|---|---|---|
| 1 | Purpose | Sales impressions + checkout-funnel steps for the organizer only |
| 2 | Default | Off for headless pixel until the partner enables + installs. Embed view beacon: off until the organizer turns on Analytics on partner embeds for the event (2026-09-29, ENG-2175) |
| 3 | Ad / remkt | Never by AXYN. No silent Meta/Google injection. No AXYN remkt / no compete (OPS-10 / AXYN-DR-2026.07) |
| 4 | Consent | Consent-before-load for analytics category. Do not fire the beacon until the partner CMP (or equivalent) allows Analytics |
| 5 | Invented views | Forbidden. Never invent impressions from catalog GET or order create (ENG-500) |
| 6 | Paid step | Paid comes from orders SoR — not from the pixel |
| 7 | Counsel | Interim founder policy may ship with this copy; OPS-13 counsel harden still required — do not claim counsel-approved |
| 8 | Browser keys | Never. Secret API keys stay on the server (Credentials). The commerce pixel does not use x-api-key in the page |
Data allowlist (Sales fact)
This table is the one written list of what a funnel record may hold. Code is tested against it: a browser may not send a key that is not marked Live here, and a Live key must really be sent.
Sent by: browser = the Web SDK, AXYN pages and the commerce pixel; pixel = the commerce pixel only; server = AXYN works it out itself.
Status: Live = collected today when the organizer has analytics on. Planned = approved and disclosed here first; not collected until it ships, and this page is updated when it does.
| Field | Sent by | Status |
|---|---|---|
event_id or series, and the organizer it belongs to (from the address the step is sent to) | server | Live |
occurred_at (AXYN's clock) | server | Live |
session_key: random id, one browser tab, one per organizer | browser | Live |
checkout_host: host name of the page | browser | Live |
checkout_surface | browser | Live |
checkout_integration | browser | Live |
funnel_step: viewed, could not buy, chose tickets, details entered, checkout started, payment opened or failed, hold expired, promo tried | browser | Live |
step_outcome: sold out / not on sale / sales ended; declined / verification / other; promo worked or not. Never the code or anything typed | browser | Live |
items: ticket or pass types picked and how many. No price: AXYN prices them | browser | Live |
device_class: phone or computer | browser | Live |
referrer_host: host name of the site that sent the visitor, never the rest of its address | browser | Live |
landing_path: path and query string of the page the visit began on, scrubbed (see below); never the fragment | browser | Live |
Campaign labels utm_source, utm_medium, utm_campaign, read from that address | server | Live |
time_zone: the browser's time zone name; read once for a country, then discarded | browser | Live |
| Country and state or region from AXYN's network edge (Cloudflare) when it gives one, else from that time zone; a buyer's postal code replaces the country and state or region, and drops the city when the region no longer matches | server | Live |
| Approximate city and its point rounded to 2 decimals (about 1 km), from the edge's own lookup of the visitor's own connection (on AXYN's hosted pages, relayed from the edge in front of them); AXYN does not use the IP address for location and never stores it with these records. No city without a country. Kept after the ids are removed at 13 months, only inside counts (a city of 5 or more visitors) | server | Live |
visitor_key: random visitor id kept up to 30 days from first visit, one per organizer; never extended | browser | Live |
Named tracking link the visit came through, read from axl= in that address | server | Live |
order_id: the id of the order the partner's checkout just created, sent by the commerce pixel on checkout_start / payment_open only. Used once to link that order to the journey (next row), never stored on the record | pixel | Live |
| Link from the record to the order it led to, made by AXYN: from the journey id sent on order create, or from the order the pixel's checkout step names (ENG-2470) | server | Live |
What is stored in the visitor's browser
| Key | Where | Set by | Lifetime | Status |
|---|---|---|---|---|
axyn_event_view_session_key:<organizer> | session storage | Web SDK, AXYN pages | Until the tab closes | Live |
axyn_funnel_landing:<organizer> | session storage | Web SDK, AXYN pages | Until the tab closes | Live |
axyn_pixel_session | session storage | Commerce pixel | Until the tab closes | Live |
axyn_pixel_landing | session storage | Commerce pixel | Until the tab closes | Live |
axyn_funnel_visitor:<organizer> | local storage | Web SDK, AXYN pages | Up to 30 days from first visit | Live |
axyn_pixel_visitor:<e or p>:<id> | local storage | Commerce pixel | Up to 30 days from first visit | Live |
axyn_analytics_choice | local storage | AXYN pages only | Until the visitor changes it | Live |
axyn_analytics_choice holds only the visitor's answer (accepted or
rejected) to the analytics banner on AXYN-hosted pages, so they are asked
once. It is strictly necessary storage and is never set on a partner's site,
where the partner's own consent tool decides (analyticsConsent, off
until the partner passes true).
The two "visitor" keys hold the returning-visitor id and the day it was made. The id is random, is never extended by a later visit, and is separate for each organizer (the pixel keeps one per event or series, so two organizers on one site can never match a visitor). It is removed when analytics consent is withdrawn or a Global Privacy Control signal appears. Browsers that cap script-written storage, such as Safari, may keep it for less than 30 days. Clearing storage, a private window, or another device is a new visitor: AXYN does not try to recognise anyone again.
The two "landing" keys hold where the tab's visit began (the scrubbed address and the referring host), so a campaign is still known on later pages.
Nothing is written before analytics is allowed (organizer switch on, your consent grant where you gate it, no Global Privacy Control signal). No cookies are set.
How long it is kept
The browser ids, the landing page address, and the link to an order are removed from stored records 13 months after the record was made, or sooner on an erasure request. Before that happens the totals are saved: how many visitors there were per day, how far they got, why they stopped, and where they came from (campaign tags, referring site, device, place down to the approximate city where 5 or more visitors were there, and named tracking link). A paid order keeps the same "where it came from" details and loses its link to the visit. Organizers can still compare one year with the next. The saved totals hold counts only: no browser id, no page address, no link to an order. When a saved group is fewer than 5 visitors it is shown as "Other", so no one stands out. Ticket types and time to buy are saved as counts as well: how many visitors wanted, took to checkout and bought each ticket or pass type, and how long buying took, in broad bands (under an hour, under a day, and so on) rather than an exact time.
The landing page address, and why it is kept
Organizers and partners asked for this. The part of a link after the ? is
where marketing puts its detail: which campaign, which ad, which email. With
it an organizer can see which promotion led to sales and which did not, and
match a sale back to the ad that earned it (click references such as gclid
and fbclid are kept for that purpose). AXYN uses it only for the
organizer's reporting and never sends it to an ad platform.
Because a link can carry anything, the address is scrubbed before it is stored:
- The fragment (after
#) is never sent. - Only campaign parameters keep their value:
utm_*, the tracking linkaxl, the click referencesgclid,fbclid,msclkidandttclid, Mailchimp's campaign idmc_cid, and AXYN's ownorgandevent. Every other parameter keeps its name and loses its value, so the subscriber ids email tools add to each link (mc_eid,_kxand the like) are never stored. A campaign parameter named like identity or a secret loses its value too. - Any value that looks like an email address or a phone number is removed, whatever the parameter is called.
- The address is capped in length.
- It is removed with the browser ids at 13 months. Totals per campaign are kept.
Orders have stored the page address since checkout attribution shipped; the same scrub applies there.
Data denylist (do not collect on the beacon)
- Email, name, phone, or other contact identity before purchase
- Email, phone, sign-in tokens, or anything else personal that happens to sit in a page address: scrubbed before storage (see above)
- The fragment of a page address (after
#) - Fingerprints and cross-site ID sync. Ad click references in a landing address are stored for the organizer's reporting only, never used or shared by AXYN for advertising
- Anything the visitor types, including promo codes
- Session replay / DOM capture on partner pages
- Whole-site browsing outside ticket / checkout surfaces
- The IP address on stored view/funnel facts
- Precise location: street address, postal code before purchase, device GPS, or any point finer than a city's point rounded to 2 decimals
- Tenant secret API keys in page HTML (pixel install must not embed them)
Duties
Partner (controller of their website)
- List AXYN under Analytics (or equivalent) in their cookie / privacy notice
- Gate script load on visitor analytics consent where their law requires it
- Adapt the suggested disclosure below into their policy / CMP vendor list
- Keep
AXYN_API_KEYon the server only — never in the pixel snippet
AXYN (processor / service for organizer Sales insights)
- Collect only the allowlist; aggregate on Sales; no cross-tenant remkt
- Ship install docs, consent hook, and this disclosure pack with the pixel
- Keep public
/legal/privacyaligned (partner-page commerce signals vs PostHog) - Show honest N/A on Sales when the pixel is not enabled, not installed, or consent denied
Suggested partner disclosure
Partners adapt this into their cookie / privacy notice (Analytics category):
We use AXYN to sell tickets. When you view or start buying tickets, AXYN may receive pseudonymous analytics data: a random id kept in your browser (for the browser tab, or for up to 30 days), the address of the page you arrived on including its campaign details (with anything that looks like personal information removed), the host name of the site that sent you here, whether you are on a phone or a computer, your approximate location (country, region and city, worked out by AXYN's network provider from the IP address your request comes from, or from your browser's time zone; if you buy, the postal code you enter replaces the country and region, and the city is dropped if it is no longer in that region; your IP address is not stored), the event, the checkout steps you reach, and the ticket types you choose. If you buy, it can be linked to your order so the organizer can count how many visits end in a purchase. It is used only to provide checkout analytics to the organizer. It is not used by AXYN to advertise to you or sell your data. Manage this under Analytics cookies.
That text covers everything in the allowlist, including the Planned rows, so you do not need to change it again as they ship.
CMP mapping
| CMP category | AXYN commerce insights |
|---|---|
| Necessary / Essential | Do not place here |
| Analytics / Statistics | Yes — default mapping |
| Marketing / Advertising | No (unless the partner separately adds their own ad pixels) |
Hard line: a buried policy link is not enough if the script runs before choice. Consent (or regional equivalent) first, then load.
Surfaces
| Surface | Impressions | Partner disclosure |
|---|---|---|
Hosted axyn.events / shop | First-party view fact | Covered by AXYN privacy |
| Web SDK embed | View beacon + opaque session key, only when the organizer turned on Analytics on partner embeds (default off) | Partner should list AXYN (suggested copy) |
| Headless / Custom API | N/A unless Partner page insights is enabled and the commerce pixel is installed with Analytics consent | Same suggested copy when you use the pixel |
Headless paid orders without the pixel still get a channel and campaign in
Conversion → Sources from the checkout_utm_* sent on order create
(ENG-2575), marked "reported by the selling partner". That reads only the
three tags the order already stores: no new personal data is read or
stored, nothing runs in the buyer's browser, and no view or step is made.
Install (headless commerce pixel)
Shipped path: optional, off by default. Same allowlisted
POST /v1/events/{eventId}/views body the Web SDK uses, with
checkout_surface: "partner_headless" and
checkout_integration: "headless_api". No browser API key.
-
In AXYN Admin, open the event's Setup page and turn on Partner page insights (default off). That unlocks headless view ingest for that event only. With the flag off, headless view posts return
422 pixel_disabled. -
Copy the install snippet from the same Setup section (or use the shape below) on the ticket / checkout page only — not site-wide. Do not add
data-axyn-api-key,x-api-key, or anyaxyn_sk_...secret to the page.<script> window.axyn = window.axyn || function () { (window.axyn.q = window.axyn.q || []).push(arguments); }; </script> <script async src="https://api.axyn.events/v1/commerce-pixel.js"></script> <script> // Call only after your CMP grants Analytics consent. axyn('consent', { analytics: true }); axyn('view', { eventId: 'EVENT_ID' }); </script>Then report each step as the buyer reaches it, with the same
eventId:Call When axyn('view', { eventId })The ticket page is shown axyn('tier_select', { eventId })The buyer picks a ticket or pass type axyn('cart', { eventId })The buyer has a cart (same Sales step as tier_select)axyn('checkout_start', { eventId, orderId })The order is created and payment opens; orderIdis the idPOST /v1/ordersreturnedFor a series and its passes, pass
{ seriesId }in place of{ eventId }on every call (turn Partner page insights on in the series' Setup). A series has one funnel for all its programs; a call that names both, or neither, sends nothing.More steps, when your checkout has them:
unavailable(the page was shown sold out or not on sale),details,payment_open,payment_failed,hold_expired,promo_tried. Two optional details on any step:axyn('tier_select', { seriesId, items: [{ tierId: 'TICKET_TYPE_ID', quantity: 2 }], // what was picked; no price }); axyn('payment_failed', { eventId, outcome: 'declined' });outcomeis one of:sold_out,not_on_sale,sales_ended(forunavailable);declined,verification,other(forpayment_failed);worked,did_not_work(forpromo_tried). Never send a promo code or anything the buyer typed. The pixel adds the device class, the referring host and the scrubbed landing address by itself.To let the organizer count which visits ended in a purchase, pass the order id on
checkout_start(andpayment_open, if you send it). Your checkout already has it:POST /v1/ordersreturns it asdata.order.id.axyn('checkout_start', { seriesId, orderId: response.data.order.id });AXYN then links that order to this visit itself (ENG-2470). It does so only for an order of the same organizer, for the same event or series, created in the last hour and not linked already. The order id is used for the link and is not kept on the funnel record. Nothing about the buyer is sent.
If your server can send the journey id instead, that works too: include it as
funnel_session_keyon order create.axyn('getSession', function (id) { // id is null until analytics consent is granted // send it to your server; include it as funnel_session_key on order create });An order is never refused or delayed because of either; a missing or unknown id is ignored. The organizer sees totals, never one buyer's trail.
Each step is sent once per session and event or series. There is no paid call: Paid comes from the order.
Replace
EVENT_IDat render time. The script origin becomes the API base (production defaulthttps://api.axyn.events). Commands queued before the script loads are flushed when it runs. -
Wire your CMP so
axyn('consent', { analytics: true })only fires after the visitor accepts Analytics. Denying consent clears any queued views without sending.GET /v1/commerce-pixel.jsitself is static JS (no consent gate on download); the script never callsfetchuntil consent is granted. Each step sends only the allowlist above — never email, name or phone, and the landing address only after the scrub described above. Callingaxyn('consent', { analytics: false })later also removes the returning-visitor ids the pixel stored. A Global Privacy Control signal always opts the visitor out, whatever your page granted: nothing is sent, no id is made, and an id from an earlier visit is removed. Sending a buyer on to an AXYN page. If your page links to an AXYN event or checkout page, add the journey id after a#so the visit stays one journey:axyn('getSession', (id) => { link.href += '#axj=' + id }). The part after#is never sent to a server, so the id reaches no log. Web SDK users can build it withfunnelHandoffFragment(id). -
Sales CVR / funnel uses real facts; without enable, install, or consent → N/A, not invented rates. Paid still comes from orders, not the pixel. Without the pixel, Conversion → Sources is no longer N/A for paid orders that carry the
checkout_utm_*your server sent on order create (ENG-2575): each is credited to its channel and campaign, marked "reported by the selling partner". Views, funnel steps and rates stay N/A; only the pixel gives those. -
Organizer UI: event Sales shows partner page insights status (
tracking/enabled_not_installed/off/sparse). Portfolio may soft-cue events with headless paid orders but no insights — never invent CVR when off.
Server catalog / checkout still use your secret API key on the server only — see Credentials.
What this is not
- Eventbrite-style “paste your Meta Pixel” for ad ROAS (separate product if ever offered; needs its own consent / “share” review)
- Equaticket-style “fire your own GA4 only” with no in-product Sales truth
- AXYN PostHog product analytics (internal; not organizer Sales SoR)
- A reason to put tenant secret API keys in HTML