get_custom_events
Raw custom events with their JSON properties and session context — the debugging view.
When to use it
To inspect exactly what is being recorded. For metrics use get_custom_event_stats; to discover names use get_custom_event_definitions first.
Ask for it like this
You do not name the tool. These are questions that make an assistant reach for it:
Show me the raw size_chart_opened events from yesterday.
Parameters
eventName
Restrict to a single event name.
pageUrl
Restrict to pages containing this string.
limit
Maximum events to return.
Shared parameters it accepts
Documented in full on the tool reference index.
Date window — defaults to the last 30 days.
dateFrom
Start of the window, YYYY-MM-DD. Inclusive.
dateTo
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.
events
Per event: name, JSON properties, page, timestamp, device, visitor and session_converted.