Get Period Summary
get_period_summaryGet one frozen calendar month or quarter: the whole client report in one call.
This is THE tool for any calendar-month or quarter figure and for a
monthly or quarterly client report. A closed month is read from an archive
frozen when the month closed, so it answers identically however much later
it is asked. The open month is computed month to date and period.status
says open. A quarter is derived from its three months. Never approximate
a month with days=30 or days=31; the window slides and the figure drifts.
Every delta and direction in metrics is already computed with the sign
right: value, prior, delta, delta_pct, direction (up, down, held,
higher, lower) and, for ranks, positions_gained. Quote them as given and
never re-derive them from a daily series or a days window.
period.fields_missing lists what cannot be reported for that period; say
those are not reported rather than substituting a rolling read.
breakdowns carries visibility by model and by tag, top competitors, top
prompts, top cited pages, gap domains, perception categories and
competitors, and the closing descriptors. headline_metric_ids names the
figures a report leads with and metric_meta gives each one's unit and
direction of improvement.
Views:
'summary' (default): the period, the prior period,
metrics,breakdowns,headline_metric_ids,groups, andmetric_meta.'list': the index of archived months and quarters plus the open month, so you can see what is frozen before asking for it.
Examples:
"How did August compare with July?": period="2026-08". July is the prior period and is already alongside every figure.
"Give me Q3": period="2026-Q3".
Args: brand_id: The brand to report on (required). period: A month as YYYY-MM (2026-08) or a quarter as YYYY-Qn (2026-Q3). Omit for the most recently closed month. view: 'summary' (default) or 'list'. compare: Include the prior period and the computed deltas. Default true. include_definitions: Add each metric's one-line definition, aggregation note, quarter rule, and learn link, ready for a client glossary. Default false. months: view='list' only: how many closed months to index, 1-36. Default 12. response_format: 'concise' (default) caps long breakdown lists to protect context; 'detailed' returns every row (still held under the response ceiling).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| view | No | summary | |
| months | No | ||
| period | No | ||
| compare | No | ||
| brand_id | Yes | ||
| user_intent | No | Analytics hint: the user's latest request in one short sentence. Omit secrets and prior chat. | |
| response_format | No | concise | |
| include_definitions | No |