Sign in
charts

Dashboard chart with category information.

This endpoint returns the data required to generate a chart with basic category information.

get/v1/chart/category/overview

Query parameters

startstring date required

A date formatted YYYY-MM-DD.

endstring date required

A date formatted YYYY-MM-DD.

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Response

Line chart oriented chart information. Check out the model for more details. Each entry is a line (or bar) in the chart.

labelstring string

This is the title of the current set. It can refer to an account, a budget or another object (by name).

currency_idstring string

The currency ID of the currency associated with this object.

currency_namestring string

The currency name of the currency associated with this object.

currency_codestring string

The currency code of the currency associated with this object.

currency_symbolstring string
currency_decimal_placesinteger
primary_currency_idstring string

The currency ID of the administration's primary currency.

primary_currency_namestring string

The currency name of the administration's primary currency.

primary_currency_codestring string

The currency code of the administration's primary currency.

primary_currency_symbolstring string

The currency symbol of the administration's primary currency.

primary_currency_decimal_placesinteger

The currency decimal places of the administration's primary currency.

datestring date-time
start_datestring date-time
end_datestring date-time
typestring string

Indicated the type of chart that is expected to be rendered. You can safely ignore this if you want.

period'1D' | '1W' | '1M' | '3M' | '1Y' | 'custom' string

Period of the chart.

yAxisIDinteger

Used to indicate the Y axis for this data set. Is usually between 0 and 1 (left and right side of the chart).

entriesobject

The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value.

pc_entriesobject

The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value.

Example response

[
  {
    "label": "Checking account",
    "currency_id": "5",
    "currency_name": "Euro",
    "currency_code": "EUR",
    "currency_symbol": "$",
    "currency_decimal_places": 2,
    "primary_currency_id": "5",
    "primary_currency_name": "Euro",
    "primary_currency_code": "EUR",
    "primary_currency_symbol": "$",
    "primary_currency_decimal_places": 2,
    "date": "2026-08-01T00:00:00+00:00",
    "start_date": "2026-08-01T00:00:00+00:00",
    "end_date": "2026-08-31T23:59:59+00:00",
    "type": "line",
    "period": "1M"
  }
]

Changes

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