Skip to main content
POST
/
reports
/
view
/
salesByPeriod
Retrieve sales-by-period performance
curl --request POST \
  --url https://mm-api.merchantspring.io/reports/view/salesByPeriod \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "merchantId": "<string>",
  "channelId": "<string>",
  "reportOptions": {
    "fromDate": 123,
    "toDate": 123,
    "priorFromDate": 123,
    "priorToDate": 123,
    "timezone": "<string>"
  },
  "includeTax": true,
  "sellerSkus": [
    "<string>"
  ]
}
'
{
  "status": "success",
  "currency": "<string>",
  "formattedChartData": [
    {
      "startTime": "<string>",
      "endTime": "<string>",
      "sales": "<string>",
      "priorSales": "<string>",
      "unitsSold": 123,
      "priorUnitsSold": 123,
      "lineItemCount": 123,
      "priorLineItemCount": 123,
      "avgLineItemValue": "<string>",
      "priorAvgLineItemValue": "<string>",
      "pageViews": 123,
      "priorPageViews": 123,
      "pageViewsConversions": "<string>",
      "priorPageViewsConversions": "<string>",
      "totalSessions": 123,
      "priorTotalSessions": 123,
      "sessionConversions": "<string>",
      "priorSessionConversions": "<string>",
      "buyboxWinPercentage": "<string>",
      "priorBuyboxWinPercentage": "<string>",
      "adSpend": "<string>",
      "priorAdSpend": "<string>",
      "adSales": "<string>",
      "priorAdSales": "<string>",
      "impressions": 123,
      "priorImpressions": 123,
      "clickThroughRate": "<string>",
      "priorClickThroughRate": "<string>",
      "acos": "<string>",
      "priorAcos": "<string>",
      "tacos": "<string>",
      "priorTacos": "<string>",
      "currency": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

Report filters that identify the merchant, time range, and marketplace scope to evaluate.

Payload used to request the sales-by-period view report.

​
merchantId
string
required

MerchantSpring merchant identifier for the account whose performance should be returned.

​
channelId
string
required

MerchantSpring channel identifier for the account whose performance should be returned.

​
reportOptions
object
required

Defines the reporting window and comparison period that should be analysed.

​
includeTax
boolean

True by default. When true, gross sales figures include tax; when false, results are reported net of tax.

​
sellerSkus
string[]

Optional list of seller SKUs to restrict the dataset to specific products.

Response

Aggregated performance data grouped to match the requested interval.

Successful response returned by the sales-by-period report endpoint.

​
status
enum<string>
required

Indicates that the request completed successfully.

Available options:
success
​
currency
string
required

Currency code associated with the returned metrics.

​
formattedChartData
object[]
required

Display-ready metrics including formatted strings and comparison values for each interval.