get_events
Read-only
Custom events (sent with pagelens.track) and outbound clicks with counts and their properties.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | End date YYYY-MM-DD, inclusive (default today) | |
| from | No | Start date YYYY-MM-DD (overrides period) | |
| limit | No | Rows to return (default 10) | |
| period | No | Time range (default 7d) | |
| filters | No | Optional filters "dimension:value" (is). Other operators go after the dimension: "page!:/x" is not, "page~:blog" contains, "page!~:blog" does not contain, "page^:/docs" starts with. Dimensions: page, title, hostname, referrer, channel, utm_source, utm_medium, utm_campaign, browser, os, device, screen, country (ISO code), city, language, event, tag | |
| site_id | Yes | Site id from list_sites | |
| timezone | No | IANA timezone for days and hours, e.g. Europe/Berlin (default UTC) | |
| segment_id | No | Apply a saved segment (see list_segments); combines with filters |