Documentation

get_click_analysis

Click totals for one page — normal, rage and dead — with the rates and DTC benchmarks attached.

When to use it

A fast read on whether a page has a clicking problem at all, before you spend calls on element or zone breakdowns.

Ask for it like this

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

Do people rage-click on my checkout page?

Parameters

url
stringrequired
Page to analyse, matched as a substring.

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.

Session filters — narrow the result to one audience.

device
enum
Keep only sessions on this device class.
mobiletabletdesktop
visitorType
enum
Keep only first-time or only returning visitors.
newreturning
utmSource
string
Keep only sessions from this UTM source, for example google.
utmMedium
string
Keep only sessions from this UTM medium, for example cpc.
utmCampaign
string
Keep only sessions from this UTM campaign name.
theme
string
Keep only sessions that rendered this Shopify theme id (bare numeric id). Use it to isolate one arm of a theme A/B test. Sessions recorded before 7 August 2026 carry no theme id and drop out.

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.

totalClicks
All clicks recorded on the page in the window.
rageClicks
Clicks that formed a frustrated repeated burst.
deadClicks
Clicks on elements with no handler and no href.
rageRate
Rage clicks over total, with a confidence interval.
deadRate
Dead clicks over total, with a confidence interval.
benchmarks
Typical DTC ranges, so the rate above has something to be judged against.

Pairs with