Get Period Summary

One frozen period, the whole client report.

Every metric a monthly report leads with, for one calendar month or quarter, with the prior period alongside and each delta and direction already computed with the sign right. A closed month is read from the archive frozen when it closed, so the figure you publish can be fetched again identically. The open month is computed to date and says so.

metrics holds the single-number figures, breakdowns the lists and maps (visibility by model and tag, top competitors, top prompts, top cited pages, gap domains, perception categories and competitors, descriptors), metric_meta the unit and direction of each, and definitions the prose when include=definitions. view=list returns the index of what is archived.

Several brands at once: pass brand_ids (comma-separated UUIDs, up to 12 after de-duplication) instead of brand_id. The response is one compact row per brand per closed month in rows, each figure with the prior month's value and the server-computed delta, plus brands, months, metric_ids and metric_meta. Ids that are not among your brands come back in excluded and are never read. period as YYYY-MM keeps that month and the month before it; quarters, view=list, compare and include do not apply to a brand list. The open month is not included, and a metric a brand's plan does not include is null with a note on that brand. Above 12 brands, download the Excel workbook from the Reports page.