What is collected
MeridianProvider subscribes to the Web Vitals that Shopify App Bridge reports for your embedded app, and sends these three to Meridian:
App Bridge also reports FCP and TTFB. The SDK drops them, and Meridian stores nothing else from the report.
Each sample carries the metric and its value, the page the app opened on, the device (desktop or mobile), the store, and the time Meridian received it. It carries no user agent, no IP address and no identity of the person using the app. The country App Bridge reports is not sent.
How it is counted
- One page view is one load of your app. App Bridge hands over the load’s LCP, INP and CLS once the merchant interacts with the page. A load the merchant leaves without a click or a key press in your app may not be counted.
- Every sample counts against the page the app opened on. App Bridge does not say which screen a report comes from, so the SDK sends the route the app loaded on with every metric of that load. A merchant who opens
/appand then moves to/app/bundles/:idinside the app counts once, on/app: a slow click or a layout shift on the bundle screen counts against/app. A screen gets samples of its own only when the app opens on it, after a reload or from a link straight to it. - p75 uses the nearest rank. The value that 75% of samples are at or under, with no interpolation. Home and the reports use the same calculation.
- The window is the last 28 days, today included. The reports compare with the 28 days before.
- At least 100 samples of a metric are needed before Home says whether it passes. A page counts as failing only with at least 100 page views in the window and a p75 over a limit.
- Test stores are left out (development stores and stores with only test charges), as in the rest of Meridian.
- The figures are self-reported by your app’s own frontend. Meridian records what the browser sends, rate-limited and checked for range, and cannot verify it. Delivery is best effort: the SDK sends half a second after App Bridge reports, so a load the merchant leaves within that half second, or a request the browser drops, is never counted. Your p75 can differ from the one Shopify scores.
Pages
Meridian stores the route, not the address. Anything that looks like an identifier or personal data becomes:id:
- the query string and the hash are dropped,
- a segment that is all digits, a UUID, a long hex string, a Shopify global id, a long token with a digit, or anything with a character outside letters, digits,
-and_(an email address, a file name, an encoded value) becomes:id, - a route keeps at most 8 segments and 200 characters.
/app/bundles/123 is stored as /app/bundles/:id, and /app/customers/jane@shop.com as /app/customers/:id. A short plain word stays as it is, because it cannot be told from a route name: keep search terms and names in the query string, which is dropped, not in the path.
An app is kept to 500 distinct pages. Pages seen after that are stored as /(other).
Where you see it
- Home: the Built for Shopify card shows LCP, INP and CLS over the last 28 days, each with its p75, whether it passes, and how far it is from the limit. Its Built for Shopify badge is greyed out until all three pass, and hovering it lists the requirements. A row in Needs attention says how many pages fail. See Home.
- Reports: four built-in reports under Web performance. Web Vitals by day is a table of LCP, INP and CLS p75 for each day. LCP by day, INP by day and CLS by day are line charts, each against its limit. They read the Page views dataset, so you can group by page or device, filter, change the period and compare. See Report Builder.
Limits
A request over the rate limit answers
429. These requests are not counted against your plan’s SDK request allowance.
Plans
Web Vitals are available on every plan that includes the SDK. The Private plan has no SDK, so there is nothing to send. They are not metered and not part of the Plan Builder.Data and retention
Samples are kept for 180 days, then deleted. They are deleted with the app, and for one store when Shopify sends that store’sshop/redact request. They are never shown to anyone but the app’s own members.
Turn it off
PasswebVitals={false} to the provider:
captureWebVitals() does the same job. Call it once in the browser, as early as you can, and keep the function it returns to stop.
If your app reads Web Vitals too
App Bridge keeps a singleshopify.webVitals.onReport callback: a second call replaces the first. The SDK shares it with your app. A callback you register in an effect, or anywhere after MeridianProvider first renders, keeps receiving every report beside Meridian, and your onReport(null) clears only yours. A callback registered before that, at module level, is replaced: move it into an effect.