GET public/v2/streams/{streamKey}/logs?from={from}&to={to}&take={take}&skip={skip}&minValue={minValue}&maxValue={maxValue}&postProcessIfAvailable={postProcessIfAvailable}

Return logs inside a stream

Request Information

URI Parameters

NameDescriptionTypeAdditional information
streamKey

globally unique identifier

Required

from

date

Required

to

date

Required

take

integer

Default value is 0

skip

integer

Default value is 0

minValue

decimal number

None.

maxValue

decimal number

None.

postProcessIfAvailable

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

BitPool.Base.Web.StreamLogsListModel
NameDescriptionTypeAdditional information
Data

Collection of BitPool.Base.Entities.ValueEntity

None.

Total

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {
      "StreamKey": "e81fd89e-db90-4e14-a6bb-215fb351ce5b",
      "Timestamp": "2019-05-19T19:35:49.276+00:00",
      "Value": 1.1,
      "ValueString": "sample string 2",
      "Calculated": true
    },
    {
      "StreamKey": "e81fd89e-db90-4e14-a6bb-215fb351ce5b",
      "Timestamp": "2019-05-19T19:35:49.276+00:00",
      "Value": 1.1,
      "ValueString": "sample string 2",
      "Calculated": true
    }
  ],
  "Total": 1
}

application/xml, text/xml

Sample:
<StreamLogsListModel>
  <Data>
    <ValueEntity>
      <StreamKey>e81fd89e-db90-4e14-a6bb-215fb351ce5b</StreamKey>
      <Timestamp>2019-05-19T19:35:49.2762844+00:00</Timestamp>
      <Value>1.1</Value>
      <ValueString>sample string 2</ValueString>
      <Calculated>true</Calculated>
    </ValueEntity>
    <ValueEntity>
      <StreamKey>e81fd89e-db90-4e14-a6bb-215fb351ce5b</StreamKey>
      <Timestamp>2019-05-19T19:35:49.2762844+00:00</Timestamp>
      <Value>1.1</Value>
      <ValueString>sample string 2</ValueString>
      <Calculated>true</Calculated>
    </ValueEntity>
  </Data>
  <Total>1</Total>
</StreamLogsListModel>