analytics

Get category analytics

Get category analytics for user

get/analytics/categories

Request

  • Base URL: http://localhost:3001
  • URL: http://localhost:3001/analytics/categories
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Query parameters

currenciesstring

Comma-separated currencies

typesstring

Comma-separated types (expense,income,transfer)

startDatestring required

Start date (YYYY-MM-DD)

endDatestring required

End date (YYYY-MM-DD)

groupIdstring

Optional group ID filter

breakdown'parent' | 'leaf'

Aggregation mode: 'parent' (roll up subcategories), or 'leaf' (show subcategories individually)

parentIdstring

Optional parent category ID for drilldown (returns leaf breakdown within that parent)

Response

Category analytics retrieved successfully

dataobject nullable
successboolean
messagestring

Example response

{
  "success": true,
  "message": "Success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.