Documentation

Getting started

OverviewQuickstartConnect ClaudeConnect ChatGPTConnect Cursor, Claude Code, VS Code

Core concepts

How it worksWhat gets collectedData freshnessMetrics and moneyGetting good answers

Reference

All tools37
Start here
get_cro_overviewget_opportunity_sizingget_anomalies
Funnel and conversion
get_funnel_analysisget_conversion_correlationsget_cart_analysisget_exit_analysisget_journey_patternsget_session_insights
Page and element diagnostics
get_top_issuesget_element_click_analysisget_page_dom_snapshotget_click_heatmapget_click_analysisget_page_vitalsget_page_performanceget_form_analyticsget_hover_analysisget_section_visibilityget_js_errorsget_page_templates
Products and discovery
get_product_performanceget_product_catalogget_product_changesget_search_analysisget_product_page_structure
Individual sessions
get_session_journeysget_session_summaries
Measuring a change
get_before_after
Custom events
get_custom_event_suggestionstest_custom_event_rulecreate_custom_event_rulelist_custom_event_rulesdelete_custom_event_ruleget_custom_event_definitionsget_custom_event_statsget_custom_events

Guides

Playbooks21Custom eventsPlans and limits

Support

TroubleshootingPrivacy and security

get_page_vitals

Core Web Vitals per page — LCP, INP, CLS and TTFB at p75 — graded against Google's official good, needs-improvement and poor bands.

When to use it

When conversion is weak but the UX looks fine, when mobile underperforms desktop, or on any page taking paid traffic. This is the only tool on the server that measures speed.

Ask for it like this

You do not name the tool. These are questions that make an assistant reach for it:

Is my store too slow, and is it costing me sales?
Which pages fail Core Web Vitals on mobile?

How to read the result

  • A p75 LCP above 4 seconds on a page receiving paid traffic is usually the most expensive fixable problem on a store.
  • reliable is false below 30 views reporting vitals. Do not draw conclusions from those rows.
  • vitalsSample is normally well below views, because only browsers with PerformanceObserver report. That is expected, not a tracking fault.

What will make you wrong

Caveats

  • Core Web Vitals data begins 23 July 2026. Earlier windows return nothing.
  • get_page_performance measures engagement, not speed, despite the name. Do not substitute it.

Parameters

url
string
Restrict to URLs containing this string.
limit
numberdefault: 20
Maximum pages to return. Cap 100.

Shared parameters it accepts

Documented in full on the tool reference index.

Date window — defaults to the last 30 days.

dateFrom
stringdefault: 30 days ago
Start of the window, YYYY-MM-DD. Inclusive.
dateTo
stringdefault: today
End of the window, YYYY-MM-DD. Inclusive.

Device — this tool takes device only, not the full session filter set.

device
enum
Keep only sessions on this device class.
mobiletabletdesktop

Every tool also accepts merchantId, which resolves from your connection. You never pass it.

What comes back

JSON. These are the top-level keys; date-scoped tools additionally carry a _meta block with the server date and the data coverage envelope.

pages
Per page: p75 values, per-metric grades, a failing list, vitalsSample and reliable.
thresholds
The exact good and poor boundaries used for grading.
summary
Pages measured, pages failing any metric, and low-sample pages.

Pairs with

get_funnel_analysisget_page_performance