GET
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
combined_financials
Get EndUser's combined financials
curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/combined_financials \
  --header 'x-api-key: <api-key>'
{
  "by_category": [
    {
      "label": "<string>",
      "time_period_label": "<string>",
      "value": 123
    }
  ],
  "by_sub_category": [
    {
      "label": "<string>",
      "time_period_label": "<string>",
      "value": 123
    }
  ],
  "currency": "<string>",
  "grouping": "by_month",
  "metrics": [
    {
      "label": "<string>",
      "time_period_label": "<string>",
      "value": 123
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
end_user_id_or_heron_id
string
required

Query Parameters

​
grouping
enum<string> | null
Available options:
by_month,
by_quarter,
by_year

Response

200 - application/json

OK

The response is of type object.