Render a category trend
well_render_category_trendPut a month-by-month trend with one line per category onto the category-trend card.
This tool measures nothing. Pass a trend another tool measured, as it is: for subscriptions, one category_trends entry of well_measure_subscriptions; for a cost trend, the per-month category sums of well_sum_transactions, converted at the rate the answer states and folded only by adding. Never invent a figure, and never edit a measured amount.
The card draws one line per series over the months, with a legend naming each. A series with a null label is drawn as "Uncategorised", or as the rolled-up line when is_other is true.
REFUSED rather than drawn:
monthsthat are not consecutive calendar months, oldest first, or that reach the running month (UTC) or a later one: a month still running is not comparable to a complete one. A measure that ran just before the month changed is refused on its newest month: run it againmore than 24 months
more than 6 series, the rolled-up line included: fold the smallest into one
is_otherseries, lasta series whose
amountsdo not hold one value per month, a negative amount, or a series with no reading at alltwo series with one
key, more than oneis_otherseries, or anis_otherseries that is not lasta
currencyoutside ISO-4217
The result echoes the input, and the text result is what you write the answer from: the card draws the lines and the legend only. Its gaps give each line's last month against its usual month, the mean of its readings over the up to 3 months before it (usual_amount, delta_amount, delta_percent). Quote them and compute no mean yourself. gaps.baseline_complete false means the trend holds fewer months before the last one: say so.
When the token authorizes one workspace, call this directly — no workspace call is needed first. When it authorizes several, this read will not guess which one you mean: pass workspace_id on the call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| months | Yes | The complete months drawn, `YYYY-MM`, oldest first. | |
| series | Yes | The lines, the rolled-up one last. | |
| currency | Yes | ISO-4217 code every amount is denominated in. Checked against the catalog, not its shape. | |
| folded_count | No | How many categories folded into the rolled-up line. | |
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several: this read reports one workspace's own figures and will not choose which. | |
| conversation_id | No | The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation. | |
| workspace_scope | No | Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| gaps | Yes | ||
| months | Yes | ||
| series | Yes | ||
| success | Yes | ||
| currency | Yes | ||
| computed_by | Yes | ||
| folded_count | Yes | ||
| conversation_id | No | The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation. | |
| newly_connected | No | Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later. | |
| resolved_workspace | No | The workspace that answered, when the caller named none and the token authorizes several. | |
| conversation_id_note | No | Present only when the server opened a fresh lane, stating that no choice recorded earlier was read. | |
| conversation_id_source | No | Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened. |