Skip to main content
GET/data-streams/user/{streamSlug}

Get Stream

Returns one active user stream by its slug.

A deleted stream answers 404, the same as one that never existed.

Needs PROJECT_ADMIN or PROJECT_AUDITOR.

Parameters
streamSlug *path

The Pulse Stream's slug.

projectSlug *path

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

It is unique within the org.

Responses
HTTPK9O CodeDescription
200Success
Response body (200)
data *object

A user stream: an append-only message log in the project.

id *string

The stream's internal id (pstr_...).

Address the stream by slug.

slug *string

The stream's address in the project, derived from displayName.

projectId *string

The project the stream belongs to (proj_...).

displayName *string

The name given at creation.

subjectPrefix *string

The message subject namespace the platform assigned to the stream: k9o.<region>.<org>.<project>.user.<id>.

Published messages carry subjects under it.

region *string

The region the stream's data lives in.

retentionSeconds *integer

How long each message is kept, in seconds: 900 or a whole number of hours.

retentionClass *"hot" | "warm" | "cold"

The retention class retentionSeconds falls in, which sets the storage rate: hot is 15 minutes, warm is 1 to 24 hours, cold is above 24 hours.

maxBytes *any

The storage the stream reserves, in bytes.

Null only on a stream created before a size was required.

One of: integer
or: null
status *"active"

Always active: a deleted stream is not returned.

createdAt *string <date-time>

When the stream was created.

createdBy *any

The id of the caller that created the stream; null if not recorded.

One of: string
or: null
meta *any
TypeScript
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.streams.get('<streamSlug>')

Showing example in TypeScript

Response example (200)
{
  "data": {
    "id": "string",
    "slug": "string",
    "projectId": "string",
    "displayName": "string",
    "subjectPrefix": "string",
    "region": "string",
    "retentionSeconds": 0,
    "retentionClass": "hot",
    "maxBytes": 0,
    "status": "active",
    "createdAt": "string",
    "createdBy": "string"
  }
}

More in Realtime Feeds & Streams