Client Cohort Report

gonemaster-client report renders the comparison of two snapshots of an analysis cohort as Markdown or JSON. It is the command-line form of the Diff tab’s report, and it reads the same endpoint, GET /pub/api/v1/analysis/cohorts/{dataset_tag}/report.

What the report establishes, and what each classification and category means, is in ../analysis/cohort-report.md . This page covers the command.

Usage

gonemaster-client report [dataset-tag] --from SLUG --to SLUG

The dataset tag is the cohort’s source tag. Omit it and the server’s default public cohort is used. Omit --to and the newest snapshot is used; omit --from and the snapshot captured before --to is used. So the common case is:

gonemaster-client report

Options:

  • --from SLUG: the baseline snapshot.
  • --to SLUG: the later snapshot.
  • --min-cluster N: how many domains a cluster needs (server default 3).
  • --max-spread N: how far the score moves within a cluster may spread (server default 3).
  • --limit N: movers to list, at most 500 (server default 500).
  • --offset N: the first mover to list.

--format selects the rendering and takes either position: markdown is the default and json writes the response verbatim. --output PATH writes to a file.

Finding a Cohort and a Snapshot Slug

The cohorts group answers both:

gonemaster-client cohorts list
gonemaster-client cohorts snapshots kommuner

cohorts list names every public cohort with its label, its snapshot count, and which one is the default. cohorts snapshots gives one cohort’s slugs with the capture date and the domain count, newest first; its dataset tag is optional and resolves the same way report does.

A snapshot is captured per batch, so comparing two batches of a cohort is the same call as comparing their snapshots.

Output

The Markdown report carries, in order: a provenance paragraph, the totals, the movers by cause, the clusters, the three tag tables, and the movers. It is the same content the Diff tab renders, in the same order.

A cohort with more movers than one page holds is marked under the movers table. Every other section covers the whole comparison.

Examples

Compare the two newest snapshots of the default cohort:

gonemaster-client report

Compare two named snapshots of a cohort and write the Markdown to a file:

gonemaster-client report kommuner --from 2026-06 --to 2026-09 --output report.md

Fetch the same comparison as JSON:

gonemaster-client --format json report kommuner --from 2026-06 --to 2026-09

Require six domains to form a cluster:

gonemaster-client report kommuner --min-cluster 6

See Also