v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1434243162.5 KB

Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.

get/channels/{channelName}/sample

Path parameters

channelNamestring required

The name of the channel whose message samples are retrieved.

Query parameters

maxMessagesinteger

The number of sample messages to be retrieved. The limit is 10. The default is also 10.

startTimestring date-time

The start of the time window from which sample messages are retrieved.

endTimestring date-time

The end of the time window from which sample messages are retrieved.

Response

Success

payloadsMessagePayload[]

The list of message samples. Each sample message is returned as a base64-encoded string.