Retrieve multi-channel advertising product performance

curl --request GET \
  --url https://mm-api.merchantspring.io/advertising/products \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://mm-api.merchantspring.io/advertising/products', 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/advertising/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://mm-api.merchantspring.io/advertising/products"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://mm-api.merchantspring.io/advertising/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "channel_id": "<string>",
      "product_sku": "<string>",
      "impressions": 123,
      "clicks": 123,
      "cost": 123,
      "attributed_sales": 123,
      "attributed_sales_same_sku": 123,
      "attributed_conversions": 123,
      "attributed_conversions_same_sku": 123,
      "attributed_units_ordered": 123,
      "attributed_units_ordered_same_sku": 123,
      "acos": 123,
      "click_through_rate": 123,
      "cost_per_click": 123,
      "conversion_rate": 123,
      "roas": 123,
      "product_title": "<string>",
      "image_url": "<string>",
      "link_url": "<string>"
    }
  ],
  "pagination": {
    "pageIndex": 123,
    "pageSize": 123,
    "count": 123
  },
  "meta": {
    "currency": "<string>"
  }
}

GET

advertising

products

Retrieve multi-channel advertising product performance

curl --request GET \
  --url https://mm-api.merchantspring.io/advertising/products \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://mm-api.merchantspring.io/advertising/products', 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/advertising/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://mm-api.merchantspring.io/advertising/products"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://mm-api.merchantspring.io/advertising/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "channel_id": "<string>",
      "product_sku": "<string>",
      "impressions": 123,
      "clicks": 123,
      "cost": 123,
      "attributed_sales": 123,
      "attributed_sales_same_sku": 123,
      "attributed_conversions": 123,
      "attributed_conversions_same_sku": 123,
      "attributed_units_ordered": 123,
      "attributed_units_ordered_same_sku": 123,
      "acos": 123,
      "click_through_rate": 123,
      "cost_per_click": 123,
      "conversion_rate": 123,
      "roas": 123,
      "product_title": "<string>",
      "image_url": "<string>",
      "link_url": "<string>"
    }
  ],
  "pagination": {
    "pageIndex": 123,
    "pageSize": 123,
    "count": 123
  },
  "meta": {
    "currency": "<string>"
  }
}

Authorizations

x-api-key

string

header

required

Query Parameters

channelId

string[]

required

Channel ID. Repeat the parameter for multiple channels (max 5).

productSku

string[]

Filter to the given product(s) by their normalised product identifier — an ASIN on Amazon, or the equivalent product identifier the channel's platform uses. Repeatable (max 10).

fromDate

integer

Start of date range as unix epoch seconds. Defaults to 30 days ago.

toDate

integer

End of date range as unix epoch seconds. Defaults to now. The range must not exceed 6 months.

currency

string

3-letter ISO currency code (default USD).

sortKey

string

Response column to sort by, e.g. product_sku, cost, impressions, clicks, acos, roas (default product_sku).

sortOrder

enum<string>

Sort direction (default desc).

Available options:

asc,

desc

pageIndex

integer

Zero-based page index (default 0).

pageSize

integer

Number of products per page, max 100 (default 10).

Response

Successful operation

data

object[]

Show child attributes

pagination

object

Show child attributes