Retrieve 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"
}
'import requests
url = "https://mm-api.merchantspring.io/reports/view/advertisingByChannels"
payload = {
"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"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};
fetch('https://mm-api.merchantspring.io/reports/view/advertisingByChannels', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mm-api.merchantspring.io/reports/view/advertisingByChannels",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://mm-api.merchantspring.io/reports/view/advertisingByChannels"
payload := strings.NewReader("{\n \"reportOptions\": {\n \"fromDate\": 1711843200,\n \"toDate\": 1714448800,\n \"priorFromDate\": 1711843200,\n \"priorToDate\": 1714448800,\n \"timezone\": \"America/Los_Angeles\"\n },\n \"currentCurrency\": \"USD\",\n \"includeTax\": false,\n \"vendorRevenueType\": \"orderedRevenue\",\n \"orderBy\": \"impressions\",\n \"pageIndex\": 0,\n \"pageSize\": 10,\n \"filter\": {\n \"marketplaces\": [\n \"<string>\"\n ],\n \"countries\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ]\n },\n \"searchText\": \"Amazon US\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://mm-api.merchantspring.io/reports/view/advertisingByChannels")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reportOptions\": {\n \"fromDate\": 1711843200,\n \"toDate\": 1714448800,\n \"priorFromDate\": 1711843200,\n \"priorToDate\": 1714448800,\n \"timezone\": \"America/Los_Angeles\"\n },\n \"currentCurrency\": \"USD\",\n \"includeTax\": false,\n \"vendorRevenueType\": \"orderedRevenue\",\n \"orderBy\": \"impressions\",\n \"pageIndex\": 0,\n \"pageSize\": 10,\n \"filter\": {\n \"marketplaces\": [\n \"<string>\"\n ],\n \"countries\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ]\n },\n \"searchText\": \"Amazon US\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mm-api.merchantspring.io/reports/view/advertisingByChannels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reportOptions\": {\n \"fromDate\": 1711843200,\n \"toDate\": 1714448800,\n \"priorFromDate\": 1711843200,\n \"priorToDate\": 1714448800,\n \"timezone\": \"America/Los_Angeles\"\n },\n \"currentCurrency\": \"USD\",\n \"includeTax\": false,\n \"vendorRevenueType\": \"orderedRevenue\",\n \"orderBy\": \"impressions\",\n \"pageIndex\": 0,\n \"pageSize\": 10,\n \"filter\": {\n \"marketplaces\": [\n \"<string>\"\n ],\n \"countries\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ]\n },\n \"searchText\": \"Amazon US\"\n}"
response = http.request(request)
puts response.read_body{
"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
}
}This response has no body data.Report
Retrieve advertising performance by channel
Retrieve a paginated JSON summary of advertising performance grouped by channel for the selected store and date range. Values are currency-adjusted based on the store’s country and the provided currency context.
POST
/
reports
/
view
/
advertisingByChannels
Retrieve 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"
}
'import requests
url = "https://mm-api.merchantspring.io/reports/view/advertisingByChannels"
payload = {
"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"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};
fetch('https://mm-api.merchantspring.io/reports/view/advertisingByChannels', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mm-api.merchantspring.io/reports/view/advertisingByChannels",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://mm-api.merchantspring.io/reports/view/advertisingByChannels"
payload := strings.NewReader("{\n \"reportOptions\": {\n \"fromDate\": 1711843200,\n \"toDate\": 1714448800,\n \"priorFromDate\": 1711843200,\n \"priorToDate\": 1714448800,\n \"timezone\": \"America/Los_Angeles\"\n },\n \"currentCurrency\": \"USD\",\n \"includeTax\": false,\n \"vendorRevenueType\": \"orderedRevenue\",\n \"orderBy\": \"impressions\",\n \"pageIndex\": 0,\n \"pageSize\": 10,\n \"filter\": {\n \"marketplaces\": [\n \"<string>\"\n ],\n \"countries\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ]\n },\n \"searchText\": \"Amazon US\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://mm-api.merchantspring.io/reports/view/advertisingByChannels")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reportOptions\": {\n \"fromDate\": 1711843200,\n \"toDate\": 1714448800,\n \"priorFromDate\": 1711843200,\n \"priorToDate\": 1714448800,\n \"timezone\": \"America/Los_Angeles\"\n },\n \"currentCurrency\": \"USD\",\n \"includeTax\": false,\n \"vendorRevenueType\": \"orderedRevenue\",\n \"orderBy\": \"impressions\",\n \"pageIndex\": 0,\n \"pageSize\": 10,\n \"filter\": {\n \"marketplaces\": [\n \"<string>\"\n ],\n \"countries\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ]\n },\n \"searchText\": \"Amazon US\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mm-api.merchantspring.io/reports/view/advertisingByChannels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reportOptions\": {\n \"fromDate\": 1711843200,\n \"toDate\": 1714448800,\n \"priorFromDate\": 1711843200,\n \"priorToDate\": 1714448800,\n \"timezone\": \"America/Los_Angeles\"\n },\n \"currentCurrency\": \"USD\",\n \"includeTax\": false,\n \"vendorRevenueType\": \"orderedRevenue\",\n \"orderBy\": \"impressions\",\n \"pageIndex\": 0,\n \"pageSize\": 10,\n \"filter\": {\n \"marketplaces\": [\n \"<string>\"\n ],\n \"countries\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ]\n },\n \"searchText\": \"Amazon US\"\n}"
response = http.request(request)
puts response.read_body{
"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
}
}This response has no body data.Authorizations
Body
application/json
Advertising by channels criteria
Criteria to view advertising performance by channel
Common reporting options that determine the reporting and comparison ranges
Show child attributes
Show child attributes
Example:
{
"fromDate": 1711843200,
"toDate": 1714448800,
"priorFromDate": 1711843200,
"priorToDate": 1714448800,
"timezone": "America/Los_Angeles"
}
3-letter currency code for the current view (e.g. USD, AUD). Used for exchange conversion.
Example:
"USD"
Whether tax should be included in sales figures
Example:
false
Determine whether the revenue type of a vendor should be retrieved by ordered or shipped revenue
Available options:
orderedRevenue, shippedRevenue Example:
"orderedRevenue"
The field to sort by (defaults to 'impressions')
Example:
"impressions"
Zero-based page index (defaults to 0)
Example:
0
The number of results to return per page (max 100) (defaults to 10)
Example:
10
Optional filters applied when selecting stores to include in the report
Show child attributes
Show child attributes
Optional text to match store names or marketplace identifiers when selecting stores
Example:
"Amazon US"
Was this page helpful?
⌘I