Skip to content
Nexa Platform Docs

Get Stream Status

GET
/api/v1/observability/streams/{stream_name}
curl --request GET \
  --url 'https://example.com/api/v1/observability/streams/example?database=example&schema=example&include_has_data=false'

Get stream status and staleness info.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
stream_name
required
Stream Name
string

Query Parameters

Section titled “Query Parameters”
database
required
Database
string
schema
required
Schema
string
include_has_data
Include Has Data
boolean

Header Parameters

Section titled “Header Parameters”
X-Environment-Id
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
StreamStalenessInfo

Stream staleness record.

object
name
required
Name

Stream name

string
database_name
required
Database Name

Database name

string
schema_name
required
Schema Name

Schema name

string
stale
required
Stale

Whether stream is stale

boolean
stale_after
Any of:
string format: date-time
has_data
Any of:
boolean
Examplegenerated
{
  "name": "example",
  "database_name": "example",
  "schema_name": "example",
  "stale": true,
  "stale_after": "2026-04-15T12:00:00Z",
  "has_data": true
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}