Retention and closing an account

Open Retention to change how long raw telemetry is kept or close the organisation’s account. These controls require an organisation owner and affect the hub’s copy only; local source records and policy stay on each edge. Raw telemetry is kept twelve months by default. Aggregates and generated reports remain while the account exists. Deleting raw telemetry before its period ends is not offered yet; to have it deleted, close the account or ask Common Measure.

The retention period

The page shows the period, the time before which received telemetry is deleted, and the oldest raw event held.

Set a period of 1 to 12 months. A longer period is refused. The period is measured from when the hub received each event. The hub looks for expired events every five minutes and deletes them. Every change is recorded in the audit log with the previous and new period.

Closing the account

Type the organisation’s slug, shown above the field, and press Close account. Closing:

• revokes every API key and edge key, so the next delivery is refused and your edge keys leave the public key directory;
• cancels every unused enrolment token;
• stops every signed-in session and API key from reaching the organisation.

Closing does not stop onward delivery. For thirty days the hub keeps delivering the events it already holds for each owner to the destination you set, because each owner is owed the evidence of crossings made before closure.

Thirty days after closure the hub deletes all of the organisation’s telemetry: raw events, aggregates, delivery records, batch receipts and sessions. It then removes every owner’s onward-delivery destination and the credential that owner’s consumer issued. The closure is recorded in the audit log.

After closing, a person whose organisations are all closed sees, once signed in, a notice naming the organisation with when it closed and when its telemetry is removed, in UTC. From there they can create a new organisation or sign out. A person who also belongs to an open organisation is taken to that one, and the closed organisation no longer appears in the organisation switcher.

API reference

All of these endpoints require an owner session and use its organisation.

GET /api/v1/organization/retention
PUT /api/v1/organization/retention
{ "retention_months": 6 }

GET returns the current retention state, including the received-before cutoff and the oldest raw event. PUT saves a whole number from 1 to 12 months; a value outside that range answers 400.

POST /api/v1/organization/close
{ "slug": "your-organisation" }

The answer carries closed_at and purge_at. A mismatched slug answers 400.

What is raw and what is kept

Raw telemetry is each event as your edges delivered it: its event id, exact time, source role, correlation id and the full data object. When the retention period deletes a content event (a retrieval, grounding or citation) it is folded into a URL-level aggregate: one count per wire session, UTC day, kind, content URL, licence and supplier, with the first and last time in that group. Turn boundaries are deleted at the same cutoff and leave no aggregate. They do not appear in owner reports or onward delivery.

Owner reports, supplier usage, the unattributed list and the fleet evidence view read raw events and aggregates together, so their counts, sessions, agent ids, URLs and first and last times do not change when the retention period deletes raw events. A host you register later still claims aggregated events.

Two things do change. An event that is no longer raw is not delivered onward: an owner whose destination you set after the deletion receives only the raw events still held. Supplier usage over a window snaps its bounds to UTC midnight when an aggregate crosses them, and says so in its window (suppliers).