/data-streams/userList Streams
Lists the project's active user streams, oldest first.
Deleted streams are not returned.
Needs PROJECT_ADMIN or PROJECT_AUDITOR.
| projectSlug * | path | The project's slug: the path segment after It is unique within the org. |
| HTTP | K9O Code | Description |
|---|---|---|
| 200 | Success |
| data * | object[] | The project's active user streams, oldest first. |
| id * | string | The stream's internal id ( Address the stream by |
| slug * | string | The stream's address in the project, derived from |
| projectId * | string | The project the stream belongs to ( |
| displayName * | string | The name given at creation. |
| subjectPrefix * | string | The message subject namespace the platform assigned to the stream: 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 |
| 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 |
| 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 | |
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.streams.list()Showing example in TypeScript
{
"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"
}
]
}