Goals report
report_goalsReport progress toward custom goals by specifying event, path, or URL conditions. Returns conversion metrics for the given website and time period.
Instructions
Progress toward one or more goals. Each goal is { type: 'event' | 'path', value }. Computed per goal against Umami's /reports/goal endpoint.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| os | No | ||
| tag | No | ||
| url | No | ||
| city | No | ||
| host | No | ||
| endAt | No | Explicit end — ISO 8601, YYYY-MM-DD, or epoch milliseconds. Defaults to now. | |
| event | No | ||
| goals | Yes | Goal definitions, e.g. { type: 'event', value: 'export_completed' }. | |
| query | No | ||
| range | No | Relative window: "24h", "7d", "30d", "12w", "today", "yesterday", "this-week", "last-month", "this-year". Ignored when startAt/endAt are set. Default "7d". | |
| title | No | ||
| device | No | ||
| region | No | ||
| browser | No | ||
| country | No | ||
| startAt | No | Explicit start — ISO 8601, YYYY-MM-DD, or epoch milliseconds. Overrides range. | |
| language | No | ||
| referrer | No | ||
| websiteId | Yes | Umami website UUID (obtain from list_websites). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes |