Create a marketing by product report
curl --request POST \
--url https://mm-api.merchantspring.io/reports/create/marketingByProduct \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"channelId": "<string>",
"merchantId": "<string>",
"reportOptions": {
"fromDate": 123,
"toDate": 123,
"timezone": "<string>"
}
}
'import requests
url = "https://mm-api.merchantspring.io/reports/create/marketingByProduct"
payload = {
"channelId": "<string>",
"merchantId": "<string>",
"reportOptions": {
"fromDate": 123,
"toDate": 123,
"timezone": "<string>"
}
}
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({
channelId: '<string>',
merchantId: '<string>',
reportOptions: {fromDate: 123, toDate: 123, timezone: '<string>'}
})
};
fetch('https://mm-api.merchantspring.io/reports/create/marketingByProduct', 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/create/marketingByProduct",
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([
'channelId' => '<string>',
'merchantId' => '<string>',
'reportOptions' => [
'fromDate' => 123,
'toDate' => 123,
'timezone' => '<string>'
]
]),
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/create/marketingByProduct"
payload := strings.NewReader("{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"reportOptions\": {\n \"fromDate\": 123,\n \"toDate\": 123,\n \"timezone\": \"<string>\"\n }\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/create/marketingByProduct")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"reportOptions\": {\n \"fromDate\": 123,\n \"toDate\": 123,\n \"timezone\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mm-api.merchantspring.io/reports/create/marketingByProduct")
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 \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"reportOptions\": {\n \"fromDate\": 123,\n \"toDate\": 123,\n \"timezone\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"reportId": "<string>",
"reportType": "<string>",
"status": "<string>"
}This response has no body data.Report
Create a marketing by product report
Create a “marketing by product” report. The generated report CSV contains the columns defined in the MarketingByProductReportColumns schema including ad sales, spend, ACOS, ROAS, TACOS, and new-to-brand metrics by store. Use the /reports/status/ endpoint to check report status and obtain the download URL.
POST
/
reports
/
create
/
marketingByProduct
Create a marketing by product report
curl --request POST \
--url https://mm-api.merchantspring.io/reports/create/marketingByProduct \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"channelId": "<string>",
"merchantId": "<string>",
"reportOptions": {
"fromDate": 123,
"toDate": 123,
"timezone": "<string>"
}
}
'import requests
url = "https://mm-api.merchantspring.io/reports/create/marketingByProduct"
payload = {
"channelId": "<string>",
"merchantId": "<string>",
"reportOptions": {
"fromDate": 123,
"toDate": 123,
"timezone": "<string>"
}
}
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({
channelId: '<string>',
merchantId: '<string>',
reportOptions: {fromDate: 123, toDate: 123, timezone: '<string>'}
})
};
fetch('https://mm-api.merchantspring.io/reports/create/marketingByProduct', 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/create/marketingByProduct",
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([
'channelId' => '<string>',
'merchantId' => '<string>',
'reportOptions' => [
'fromDate' => 123,
'toDate' => 123,
'timezone' => '<string>'
]
]),
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/create/marketingByProduct"
payload := strings.NewReader("{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"reportOptions\": {\n \"fromDate\": 123,\n \"toDate\": 123,\n \"timezone\": \"<string>\"\n }\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/create/marketingByProduct")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"reportOptions\": {\n \"fromDate\": 123,\n \"toDate\": 123,\n \"timezone\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mm-api.merchantspring.io/reports/create/marketingByProduct")
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 \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"reportOptions\": {\n \"fromDate\": 123,\n \"toDate\": 123,\n \"timezone\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"reportId": "<string>",
"reportType": "<string>",
"status": "<string>"
}This response has no body data.Was this page helpful?
⌘I