Skip to main content
Provides detailed spending breakdowns with trend comparisons. Group by category, merchant, or time period to understand where money is going.

​
Parameters

ParameterTypeRequiredDefaultDescription
group_bystringYes-How to group data: category, merchant, or time_period
time_periodstringYes-Time bucket: day, week, month, quarter, or year
start_datestringNo3 periods backStart date (YYYY-MM-DD)
end_datestringNoTodayEnd date (YYYY-MM-DD)
account_idsstringNoAllComma-separated account IDs
categoriesstringNoAllComma-separated category names
link_idstringNoAll linksFilter to a specific link
min_total_amountnumberNo50.00Minimum amount to group separately (smaller amounts grouped as “Other”)

​
Response

FieldTypeDescription
spendingobjectSpending data grouped as requested
spending.by_categoryarrayGroups with name, total, percentage (when group_by=category)
spending.by_merchantarrayGroups with name, total, transaction count (when group_by=merchant)
spending.by_time_periodarrayGroups with period, total, breakdown (when group_by=time_period)
summaryobjectSummary statistics
summary.total_spendingstringTotal spending amount
summary.average_daily_spendingstringAverage daily spend
summary.average_monthly_spendingstringAverage monthly spend
summary.total_transactionsintegerTotal number of transactions
summary.unique_merchantsintegerNumber of unique merchants
summary.top_categorystringHighest-spending category
summary.top_merchantstringHighest-spending merchant

​
Examples

Prompt: “Break down my spending by category this month” Called with group_by: "category", time_period: "month": 
{
  "spending": {
    "by_category": [
      { "name": "Rent", "total": "1800.00", "percentage": "42.1" },
      { "name": "Groceries", "total": "620.00", "percentage": "14.5" },
      { "name": "Dining Out", "total": "340.00", "percentage": "7.9" }
    ]
  },
  "summary": {
    "total_spending": "4275.00",
    "average_daily_spending": "142.50",
    "top_category": "Rent",
    "top_merchant": "Whole Foods"
  }
}
Prompt: “Compare my spending month over month for the last quarter” Called with group_by: "time_period", time_period: "month", start_date: "2026-01-01": 
{
  "spending": {
    "by_time_period": [
      { "period": "2026-01", "total": "4100.00" },
      { "period": "2026-02", "total": "3850.00" },
      { "period": "2026-03", "total": "4275.00" }
    ]
  }
}