Parameter: aggregate

Applies to

Stream URL

Value

Boolean value, the default is false

Related

Parameter: limit

This parameter changes the format of the response envelope to contain a nested array of stream messages. The number of messages returned depends on the limit parameter, which limits the total number of records to be returned. For example, if limit is 5000, and each /stream message contains 2000 records, then the response contains two complete stream messages, and the first 1000 records from a third stream message.

Tip: aggregate can be used to reduce the effect of network latency as multiple /stream messages can be handled in a single request.

Back to help overview