Explain a traffic change
explain_traffic_changeCompare website traffic changes across periods and dimensions. Identify top shifting pages, referrers, countries, devices, channels, and events to understand traffic trends.
Instructions
Compare traffic with a previous, year-over-year, or custom period and rank observed changes across pages, referrers, countries, devices, channels, and events. Results describe association, not causation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | Yes | Unix milliseconds, ISO 8601 with timezone, or YYYY-MM-DD (UTC) | |
| limit | No | ||
| start | Yes | Unix milliseconds, ISO 8601 with timezone, or YYYY-MM-DD (UTC) | |
| filters | No | ||
| timezone | No | UTC | |
| websiteId | Yes | Umami UUID | |
| dimensions | No | ||
| comparisonEnd | No | Unix milliseconds, ISO 8601 with timezone, or YYYY-MM-DD (UTC) | |
| comparisonMode | No | previous | |
| trafficSegment | No | all | |
| comparisonStart | No | Unix milliseconds, ISO 8601 with timezone, or YYYY-MM-DD (UTC) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | JSON analytics data returned by Umami Compass | |
| meta | Yes |