POST Stats/OrderStatusLogs

Histogram of the time passed between Orders' Status change. Without Filters, to speed things up

Request Information

URI Parameters

None.

Body Parameters

GetStatusLogsRequest
NameDescriptionTypeAdditional information
FromStatus

integer

None.

ToStatus

integer

None.

DateFrom

date

None.

DateUntil

date

None.

Lang

string

None.

StoreID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "FromStatus": 1,
  "ToStatus": 2,
  "DateFrom": "2025-12-06T05:40:39.7482122+01:00",
  "DateUntil": "2025-12-06T05:40:39.7482122+01:00",
  "Lang": "sample string 5",
  "StoreID": 6
}

application/xml, text/xml

Sample:
<GetStatusLogsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Stats">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 5</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">6</StoreID>
  <DateFrom xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">2025-12-06T05:40:39.7482122+01:00</DateFrom>
  <DateUntil xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">2025-12-06T05:40:39.7482122+01:00</DateUntil>
  <FromStatus>1</FromStatus>
  <ToStatus>2</ToStatus>
</GetStatusLogsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BaseHistogram
NameDescriptionTypeAdditional information
Unit

string

None.

Min

decimal number

None.

Max

decimal number

None.

Average

decimal number

None.

Median

decimal number

None.

FirstOctile

biggest value of the first 12.5%

decimal number

None.

LastOctile

smallest value of the last 12.5%

decimal number

None.

StdDev

decimal number

None.

HistogramCoveragePercentage

how many items were discarded (not shown in the Histogram, because they are "Outliers")

decimal number

None.

BinCount

integer

None.

BinSize

decimal number

None.

Histogram

Collection of HistogramBin

None.

Response Formats

application/json, text/json

Sample:
{
  "Unit": "sample string 1",
  "Min": 2.0,
  "Max": 3.0,
  "Average": 4.0,
  "Median": 5.0,
  "FirstOctile": 6.0,
  "LastOctile": 7.0,
  "StdDev": 8.1,
  "HistogramCoveragePercentage": 9.1,
  "BinCount": 10,
  "BinSize": 11.0,
  "Histogram": [
    {
      "Start": 1.0,
      "End": 2.0,
      "Frequency": 3
    },
    {
      "Start": 1.0,
      "End": 2.0,
      "Frequency": 3
    }
  ]
}

application/xml, text/xml

Sample:
<BaseHistogram xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Stats">
  <Average>4</Average>
  <BinCount>10</BinCount>
  <BinSize>11</BinSize>
  <FirstOctile>6</FirstOctile>
  <Histogram>
    <HistogramBin>
      <End>2</End>
      <Frequency>3</Frequency>
      <Start>1</Start>
    </HistogramBin>
    <HistogramBin>
      <End>2</End>
      <Frequency>3</Frequency>
      <Start>1</Start>
    </HistogramBin>
  </Histogram>
  <HistogramCoveragePercentage>9.1</HistogramCoveragePercentage>
  <LastOctile>7</LastOctile>
  <Max>3</Max>
  <Median>5</Median>
  <Min>2</Min>
  <StdDev>8.1</StdDev>
  <Unit>sample string 1</Unit>
</BaseHistogram>