Skip to main content
Monitoring & Collection/Logging

PullTailMessages

Pull buffered messages from a live-tail session since the last cursor

GET/api/v1/logs/tail/sessions/{sessionId}/messages

Operation ID

PullTailMessages

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • sessionId
    StringRequired

    Unique identifier of the live-tail session to pull messages from

Query Parameters

  • maxCount
    Integer

    Maximum number of messages to return in this pull request Maximum number of messages to return in this pull request

    Example: 0

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

    • type
      String

      Message type indicating normal log, heartbeat, or dropped notification

      Example: log

    • timestamp
      String

      Timestamp for this resource

      Example: 2026-01-15T08:00:00Z

    • message
      String

      Log message content for type=log messages

      Example: Payment processed for order 9912

    • level
      String

      Severity level of this log message

      Example: info

    • service
      String

      Service name that emitted this log message

      Example: order-service

    • cursor
      String

      Opaque cursor value for resuming consumption from this position

      Example: cursor-0000042

    • dropped
      Integer

      Number of messages dropped due to buffer overflow

      Example: 20

    • reason
      String

      Reason for dropped messages when dropped > 0

      Example: buffer_full