Substream Journal

Returns a paginated list of journal entries (state changes and events) for a specific substream.

Request

Property	Value
Method	`GET`
URL	`/api/streams/{appName}/{streamKey}/{substreamName}/journal`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X GET "{BASE_URL}/api/streams/{appName}/{streamKey}/{substreamName}/journal" \
  -H "Authorization: Bearer YOUR_TOKEN"

Path Parameters

Parameter	Type	Required	Description
`appName`	string	Yes	Application name
`streamKey`	string	Yes	Stream key
`substreamName`	string	Yes	Substream name

Request

bash

curl -X GET "{BASE_URL}/api/streams/{appName}/{streamKey}/{substreamName}/journal" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

Pagination

Parameter	Type	Description
`data.totalItems`	integer	Total number of journal entries
`data.itemsPerPage`	integer	Number of items per page
`data.totalPages`	integer	Total number of pages
`data.currentPage`	integer	Current page number
`data.hasPrevious`	boolean	Indicates if a previous page exists
`data.hasNext`	boolean	Indicates if a next page exists
`data.lastTimestamp`	integer	Timestamp of the most recent entry (Unix timestamp in ms)

Journal Object

Parameter	Type	Description
`data.list[].id`	integer	Unique identifier of the journal entry
`data.list[].message`	string	Journal message describing the event
`data.list[].threadName`	string	Thread name that generated the entry
`data.list[].createDate`	integer	Entry creation timestamp (Unix timestamp in ms)
`data.list[].pipelineState`	string	Pipeline state at the time of entry

Metadata

Parameter	Type	Description
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)

Successful Response (200)

json

{
  "data": {
    "totalItems": 3,
    "itemsPerPage": 20,
    "totalPages": 1,
    "currentPage": 1,
    "hasPrevious": false,
    "hasNext": false,
    "lastTimestamp": 1764683374354,
    "list": [
      {
        "id": 2,
        "message": "Source State Change: PUBLISHED",
        "threadName": "WebSocketConnectReadThread-525",
        "createDate": 1764683374354,
        "pipelineState": "PUBLISHED"
      },
      {
        "id": 1,
        "message": "Publish State Change: true",
        "threadName": "WebSocketConnectReadThread-525",
        "createDate": 1764683374353,
        "pipelineState": "AWAITING"
      }
    ]
  },
  "meta": {
    "executionTime": 0,
    "generatedAt": 1764757002390
  }
}

Error Responses

Substream Not Found (404)

Parameter	Type	Description
`message`	string	Human-readable error message

json

{
  "message": "Substream not found"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.