Documentation

get_custom_event_stats

Aggregated statistics per event name, including the conversion rate of sessions that fired the event.

When to use it

To find out whether an event correlates with buying. A high session_conversion_rate suggests the behaviour is a purchase-intent signal worth designing around.

Ask for it like this

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

Do people who open the size chart buy more?

What will make you wrong

Caveats

  • session_conversion_rate is a correlation over sessions, not a causal claim. Confirm anything you plan to act on with get_conversion_correlations.

Parameters

eventName
string
Restrict to a single event name.

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.

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.

stats
Per event: total_occurrences, unique_sessions, unique_visitors, converted_sessions, session_conversion_rate, first_seen and last_seen.

Pairs with