/analytics/{datasetSlug}/rollupsList Dataset Rollups
Returns the dataset's rollups with their attestation state: attestedAt, expiresAt and attestationStatus (active, expiring_soon or expired; an expired rollup is paused, not deleted).
Requires the datasets:read permission (PROJECT_ADMIN, PROJECT_AUTHOR or PROJECT_EDITOR by default).
Callers must be members of the project (an organization role alone does not grant access); project service tokens and extension tokens cannot call it.
| datasetSlug * | path | The Dataset's slug. |
| projectSlug * | path | The project's slug: the path segment after It is unique within the org. |
| HTTP | K9O Code | Description |
|---|---|---|
| 200 | Success | |
| 401 | K9O_UNAUTHENTICATED | The caller is not signed in. |
| 403 | K9O_ACCESS_DENIED | The caller is not a member of this project; an organization role alone does not grant access. |
| 403 | K9O_IAM_POLICY_DENIED | The caller's role or IAM policy does not grant datasets:read. |
| 404 | K9O_NOT_FOUND | The project was not found for this caller (project service tokens and extension tokens cannot call this endpoint). |
| data * | object | The rollups that write to this dataset. |
| rollups * | object[] | The dataset's rollups, newest first. |
| id * | string |
|
| slug * | string | The rollup's slug, unique in the project. Its read and subscribe paths use it. |
| subjectField * | any | The source event field that names the data subject. Null when the rollup declares |
| One of: string | ||
| or: null | ||
| nonPersonal * | boolean | True when the rollup's creator declared that its source carries no personal data. |
| datasetSlug * | string | The dataset the rollup writes to. |
| source * | string | The source the rollup folds: a Pulse Stream's slug, or a telemetry signal name. Falls back to the stored stream id when the stream has been deleted. |
| dimensions * | string[] | The fields each cell is grouped by, in declared order (at most 16). |
| measures * | object[] | The declared measures, in order (at most 64). |
| name * | string | The measure's name: its key in each cell's |
| agg * | string |
|
| column | string | The source field aggregated. Absent for |
| windowSeconds * | integer | The width of each cell's time window, in seconds. |
| enabled * | boolean | Whether the rollup is set to fold. |
| reattestIntervalDays * | integer | How many days each attestation lasts: 7, 30, 90 or 365. |
| attestedAt * | string <date-time> | When a person last confirmed the rollup (created or re-attested it). |
| expiresAt * | string <date-time> |
After it the rollup stops folding until it is re-attested. |
| attestationStatus * | "active" | "expiring_soon" | "expired" |
|
| cursorSequence * | any | The source sequence the last committed fold reached, as a decimal string. Null until a fold has written a cell. |
| One of: string | ||
| or: null | ||
| lastFoldAt * | any | When the last fold ran. Null if it has never run. |
| One of: string <date-time> | ||
| or: null | ||
| lastFoldStatus * | any | How the last fold ended: Null if it has never run. |
| One of: string | ||
| or: null | ||
| createdAt * | string <date-time> | When the rollup was created. |
| meta * | object | Request metadata: cost, timing and correlation ids. |
| cost * | object | Metered usage for this request; empty when nothing was metered. |
| timing * | object | |
| gatewayMs * | number | |
| totalMs * | number | |
| context * | object | |
| requestId * | string | |
| traceId * | string | |
| projectId | string | |
| warnings | object[] | |
| code * | string | |
| message * | string | |
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.analytics.rollups.list('<datasetSlug>')Showing example in TypeScript
{
"data": {
"rollups": [
{
"id": "string",
"slug": "string",
"subjectField": "string",
"nonPersonal": false,
"datasetSlug": "string",
"source": "string",
"dimensions": [
"string"
],
"measures": [
{
"name": "string",
"agg": "string",
"column": "string"
}
],
"windowSeconds": 0,
"enabled": false,
"reattestIntervalDays": 0,
"attestedAt": "string",
"expiresAt": "string",
"attestationStatus": "active",
"cursorSequence": "string",
"lastFoldAt": "string",
"lastFoldStatus": "string",
"createdAt": "string"
}
]
},
"meta": {
"timing": {
"gatewayMs": 0,
"totalMs": 0
},
"context": {
"requestId": "string",
"traceId": "string",
"projectId": "string"
},
"warnings": [
{
"code": "string",
"message": "string"
}
]
}
}