GET public/v2/streams/{streamKey}/logs/aggregated?timeRange={timeRange}&from={from}&to={to}&aggregationType={aggregationType}&aggregationTypeString={aggregationTypeString}&aggregationPeriod={aggregationPeriod}&timeZone={timeZone}&autoTimeZone={autoTimeZone}&nullWhenNoData={nullWhenNoData}&multiplier={multiplier}&postProcessIfAvailable={postProcessIfAvailable}

return logs inside a stream, a variety of properties help to filter and aggregate the logs which are returned

Request Information

URI Parameters

NameDescriptionTypeAdditional information
streamKey

globally unique identifier

Required

timeRange

BitPool.Base.Enums.TimeRange

None.

from

date

None.

to

date

None.

aggregationType

BitPool.Base.Enums.AggregationType

None.

aggregationTypeString

BitPool.Base.Enums.AggregationTypeString

None.

aggregationPeriod

BitPool.Base.Enums.AggregationPeriod

None.

timeZone

string

None.

autoTimeZone

boolean

None.

nullWhenNoData

boolean

None.

multiplier

decimal number

None.

postProcessIfAvailable

boolean

None.

Body Parameters

None.

Response Information

Resource Description

Collection of BitPool.Base.DTO.StreamLogDto
NameDescriptionTypeAdditional information
StreamKey

globally unique identifier

None.

Timestamp

date

None.

Value

decimal number

None.

ValueString

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "StreamKey": "3c866573-2689-4ccd-aad8-021582f36881",
    "Timestamp": "2019-05-18T22:55:37.448+00:00",
    "Value": 1.1,
    "ValueString": "sample string 2"
  },
  {
    "StreamKey": "3c866573-2689-4ccd-aad8-021582f36881",
    "Timestamp": "2019-05-18T22:55:37.448+00:00",
    "Value": 1.1,
    "ValueString": "sample string 2"
  }
]

application/xml, text/xml

Sample:
<ArrayOfStreamLogDto>
  <StreamLogDto>
    <StreamKey>3c866573-2689-4ccd-aad8-021582f36881</StreamKey>
    <Timestamp>"2019-05-18T22:55:37.4488213+00:00"</Timestamp>
    <Value>1.1</Value>
    <ValueString>sample string 2</ValueString>
  </StreamLogDto>
  <StreamLogDto>
    <StreamKey>3c866573-2689-4ccd-aad8-021582f36881</StreamKey>
    <Timestamp>"2019-05-18T22:55:37.4488213+00:00"</Timestamp>
    <Value>1.1</Value>
    <ValueString>sample string 2</ValueString>
  </StreamLogDto>
</ArrayOfStreamLogDto>