Budget Aggregations

Returns aggregations based on the item grouped by, and the selected aggregation.

Group by options

API request has to include group_by parameter.

This parameter controls result aggregations and can be one or more (comma separated values) of:

  • recipient_country Non percentage weighted
  • recipient_region Non percentage weighted
  • sector Percentage weighted
  • related_activity
  • reporting_organisation
  • participating_organisation
  • participating_organisation_type
  • document_link_category
  • activity_status
  • collaboration_type
  • budget_period_start_year
  • budget_period_end_year
  • budget_period_start_quarter
  • budget_period_end_quarter
  • budget_period_start_month
  • budget_period_end_month

Aggregation options

API request has to include aggregations parameter.

This parameter controls result aggregations and can be one or more (comma separated values) of:

  • count Count of budgets
  • activity_count Count of activities
  • value Sum of budget value (in the selected currency)

Request parameters

All filters available on the Activity List, can be used on aggregations.

GET /api/budgets/aggregations/
HTTP 200 OK
						Allow: GET, HEAD, OPTIONS
						Content-Type: application/json
						Vary: Accept
						
					{
    "error_message": "Invalid value for mandatory field 'group_by'"
}