analyze
Build a GOVERNED analytics report over the rebate data. Pick a MEASURE and GROUP it BY a dimension — the report is composed from a fixed semantic layer (no raw SQL), so it's deterministic, read-only, and ties to the ledger (accrued uses the SAME earned formula as the money path). measure: 'accrued' (earned rebate), 'settled' (paid), 'basis' (transaction amount), or 'count' (events). group_by: 'agreement', 'class' (a declared dimension — pass dimension_key, e.g. interchange_class), 'month', or 'quarter'. Optionally restrict to one agreement_id. Returns the grouped rows + total. Use this when the user asks to see/analyze/break down their rebates (e.g. 'rebate accrued by interchange class', 'settled by month'). Requires a connected Aurgus account.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| measure | Yes | What to measure: accrued (earned) | settled (paid) | basis (transaction amount) | count (events). | |
| group_by | Yes | How to break it down: agreement | class (needs dimension_key) | month | quarter. | |
| agreement_id | No | Optional — restrict the report to one agreement. | |
| dimension_key | No | Required when group_by='class': the declared dimension to group by, e.g. 'interchange_class'. |