> For the complete documentation index, see [llms.txt](https://water-strategy.gitbook.io/waterstrategy/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://water-strategy.gitbook.io/waterstrategy/modeling-basics/recorders/statistical-recorders/aggregated-recorder.md).

# Aggregated Recorder

## General Description

This Recorder is used to aggregate across multiple other Recorder objects.

The class provides a method to produce a complex aggregated recorder by taking the results of other records. The *.values()* method first collects unaggregated values from the provided recorders. These are then aggregated on a per scenario basis and returned by this classes *.values()* method. This method allows *AggregatedRecorder* to be used as a recorder for in other *AggregatedRecorder* instances.

By default the same *agg\_func* function is used for both steps, but an optional *recorder\_agg\_func* can undertake a different aggregation across scenarios. For example summing recorders per scenario, and then taking a mean of the sum totals.[ ](https://pywr.github.io/pywr-docs/master/api/generated/pywr.recorders.NumpyArrayNodeCurtailmentRatioRecorder.html)[API Reference](https://pywr.github.io/pywr-docs/master/api/generated/pywr.recorders.AggregatedRecorder.html#pywr.recorders.AggregatedRecorder)

## Attributes

<table><thead><tr><th width="155">Name</th><th width="395">Description</th><th>Required</th></tr></thead><tbody><tr><td>model</td><td>pywr.core.Model</td><td>Optional</td></tr><tr><td>recorders</td><td>The other <em>Recorder</em> instances to perform aggregation over</td><td>Optional</td></tr><tr><td>agg_func</td><td>Scenario aggregation function to use when <em>aggregated_value</em> is called (default=”mean”)</td><td>Optional</td></tr><tr><td>recorder_agg_func</td><td>Recorder aggregation function to use when <em>aggregated_value</em> is called (default=`agg_func`)</td><td>Optional</td></tr></tbody></table>

## Example

coming soon...

```json
{

}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://water-strategy.gitbook.io/waterstrategy/modeling-basics/recorders/statistical-recorders/aggregated-recorder.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.