Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Logging
GETLoggingSince 1.0SynchronousAuth Required

PullTailMessages

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Query Parameters

Request Inputs

Path Parameters

  • sessionIdStringRequired

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

Query Parameters

  • maxCountInteger

    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

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • typeString

      Message type indicating normal log, heartbeat, or dropped notification

      Example: log

    • timestampString

      Timestamp for this resource

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

    • messageString

      Log message content for type=log messages

      Example: Payment processed for order 9912

    • levelString

      Severity level of this log message

      Example: info

    • serviceString

      Service name that emitted this log message

      Example: order-service

    • cursorString

      Opaque cursor value for resuming consumption from this position

      Example: cursor-0000042

    • droppedInteger

      Number of messages dropped due to buffer overflow

      Example: 20

    • reasonString

      Reason for dropped messages when dropped > 0

      Example: buffer_full

Endpoint

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

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

Operation ID

PullTailMessages

Permalink

Request Example

curl -X GET '{host}/api/v1/logs/tail/sessions/{sessionId}/messages' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history