Skip to main content
POST
/
reports
/
view
/
advertisingByChannels
View advertising performance by channel
curl --request POST \
  --url https://mm-api.merchantspring.io/reports/view/advertisingByChannels \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "reportOptions": {
    "fromDate": 1711843200,
    "toDate": 1714448800,
    "priorFromDate": 1711843200,
    "priorToDate": 1714448800,
    "timezone": "America/Los_Angeles"
  },
  "currentCurrency": "USD",
  "includeTax": false,
  "vendorRevenueType": "orderedRevenue",
  "orderBy": "impressions",
  "pageIndex": 0,
  "pageSize": 10,
  "filter": {
    "marketplaces": [
      "<string>"
    ],
    "countries": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ]
  },
  "searchText": "Amazon US"
}
'
{
  "status": "success",
  "data": {
    "items": [
      {
        "store": "Acme AU",
        "countryCode": "AUS",
        "adsales": "1200.25",
        "priorAdsales": "-",
        "spend": "300.10",
        "priorSpend": "-",
        "acos": "25.01",
        "priorAcos": "-",
        "roas": "3.99",
        "priorRoas": "-",
        "tacos": "5.00",
        "priorTacos": "-",
        "troas": "20.00",
        "priorTroas": "-",
        "impressions": 200000,
        "clicks": 5200,
        "ctr": "2.60",
        "cpc": "0.58",
        "conv": "3.40",
        "orders": 176,
        "units": 220,
        "NTB_sales": "400.00",
        "pecentage_sales_NTB": "33.33",
        "NTB_orders": 60,
        "percentage_orders_NTB": "34.09",
        "NTB_units": 70,
        "percentage_units_NTB": "31.82",
        "marketplace_id": "AUS-MKT",
        "seller_id": "SELLER-123",
        "attributed_units_ordered_same_sku": 50
      }
    ],
    "pageIndex": 0,
    "pageSize": 10,
    "totalItems": 1,
    "totalPages": 1
  }
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

Advertising by channels criteria

Criteria to view advertising performance by channel

​
reportOptions
object
required

Common reporting options that determine the reporting and comparison ranges

Example:
{
  "fromDate": 1711843200,
  "toDate": 1714448800,
  "priorFromDate": 1711843200,
  "priorToDate": 1714448800,
  "timezone": "America/Los_Angeles"
}
​
currentCurrency
string
required

3-letter currency code for the current view (e.g. USD, AUD). Used for exchange conversion.

Example:

"USD"

​
includeTax
boolean

Whether tax should be included in sales figures

Example:

false

​
vendorRevenueType
enum<string>

Determine whether the revenue type of a vendor should be retrieved by ordered or shipped revenue

Available options:
orderedRevenue,
shippedRevenue
Example:

"orderedRevenue"

​
orderBy
string

The field to sort by (defaults to 'impressions')

Example:

"impressions"

​
pageIndex
integer

Zero-based page index (defaults to 0)

Example:

0

​
pageSize
integer

The number of results to return per page (max 100) (defaults to 10)

Example:

10

​
filter
object

Optional filters applied when selecting stores to include in the report

​
searchText
string

Optional text to match store names or marketplace identifiers when selecting stores

Example:

"Amazon US"

Response

Successful operation

Paginated advertising performance by channel

​
status
enum<string>
Available options:
success,
error
​
data
object
​
error
string