roll_up_metric
Reconstruct untagged aggregate figures from an issuer's reported components when a direct fact lookup returns nothing.
Instructions
Rebuild a figure from the components this issuer reported when the
figure itself is not tagged. Use when get_fact finds nothing for an
aggregate. Below a paid plan the value comes without algorithm and
contributions.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"entity_id": "<entity_id>",
"hub_concept_code": "<hub_concept_code>",
"fiscal_year": "<fiscal_year>"
},
"name": "roll_up_metric"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| entity_id | Yes | ||
| fiscal_year | Yes | ||
| hub_concept_code | Yes | ||
| fiscal_period_type | No | FY |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | No | ||
| value | No | ||
| source | No | ||
| currency | No | ||
| algorithm | Yes | How the value was obtained for this entity, on a paid plan: tagged, equivalent_concept or sum_of_components ('unknown' otherwise). | |
| fiscal_year | Yes | ||
| parent_code | Yes | ||
| parent_label | No | ||
| contributions | No | ||
| fiscal_period_type | Yes |