Skip to main content
GET/rollups

List Rollups

Returns every rollup in the project whose dataset the caller can read, with its read and subscribe endpoints.

Requires the datasets:list permission.

Callers must be members of the project (an organization role alone does not grant access); project service tokens and extension tokens cannot call it.

Parameters
projectSlug *path

The project's slug: the path segment after @.

It is unique within the org.

Responses
HTTPK9O CodeDescription
200Success
401K9O_UNAUTHENTICATEDThe caller is not signed in.
403K9O_ACCESS_DENIEDThe caller is not a member of this project; an organization role alone does not grant access.
403K9O_IAM_POLICY_DENIEDThe caller's role or IAM policy does not grant datasets:list.
404K9O_NOT_FOUNDThe project was not found for this caller (project service tokens and extension tokens cannot call this endpoint).
Response body (200)
data *object

The project's rollups.

rollups *object[]

The rollups, newest first.

Only rollups whose dataset the caller may read are listed.

id *string

rollup_ id.

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 nonPersonal instead (or, for a rollup made before declarations were required, neither).

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 measures.

agg *string

count, last, sum, avg, min, max, count_distinct, p50, p95 or p99.

columnstring

The source field aggregated.

Absent for count.

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>

attestedAt plus reattestIntervalDays.

After it the rollup stops folding until it is re-attested.

attestationStatus *"active" | "expiring_soon" | "expired"

expiring_soon within 14 days of expiresAt.

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: ok for a clean fold, otherwise why it did not fold (for example attestation_expired, stale_principal_denied, dataset_gone, write_error or failed).

Null if it has never run.

One of: string
or: null
createdAt *string <date-time>

When the rollup was created.

endpoints *object

Absolute paths: /@<project>/rollups/<slug>/read and /subscribe.

read *string

The path to read the rollup's cells.

subscribe *string

The path to subscribe to the rollup's cells as they change.

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
projectIdstring
warningsobject[]
code *string
message *string
TypeScript
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.rollups.list()

Showing example in TypeScript

Response example (200)
{
  "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",
        "endpoints": {
          "read": "string",
          "subscribe": "string"
        }
      }
    ]
  },
  "meta": {
    "timing": {
      "gatewayMs": 0,
      "totalMs": 0
    },
    "context": {
      "requestId": "string",
      "traceId": "string",
      "projectId": "string"
    },
    "warnings": [
      {
        "code": "string",
        "message": "string"
      }
    ]
  }
}

More in Analytics & Intelligence