Retrieve multi-channel advertising campaign performance

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

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

fetch('https://mm-api.merchantspring.io/advertising/campaigns', 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/campaigns",
  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/campaigns"

	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/campaigns")

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>",
      "campaign_id": "<string>",
      "ad_type": "<string>",
      "campaign_name": "<string>",
      "campaign_status": "<string>",
      "budget": 123,
      "budget_type": "<string>",
      "start_date": "<string>",
      "end_date": "<string>",
      "targeting_type": "<string>",
      "bidding_strategy": "<string>",
      "cost_type": "<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,
      "attributed_orders_ntb": 123,
      "attributed_units_ordered_ntb": 123,
      "attributed_sales_ntb": 123,
      "attributed_orders_ntb_percentage": 123,
      "attributed_units_ordered_ntb_percentage": 123,
      "attributed_sales_ntb_percentage": 123,
      "attributed_detail_page_views_clicks": 123,
      "acos": 123,
      "click_through_rate": 123,
      "cost_per_click": 123,
      "cost_per_acquisition": 123,
      "conversion_rate": 123,
      "roas": 123
    }
  ],
  "pagination": {
    "pageIndex": 123,
    "pageSize": 123,
    "count": 123
  },
  "meta": {
    "currency": "<string>"
  }
}

GET

advertising

campaigns

Retrieve multi-channel advertising campaign performance

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

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

fetch('https://mm-api.merchantspring.io/advertising/campaigns', 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/campaigns",
  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/campaigns"

	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/campaigns")

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>",
      "campaign_id": "<string>",
      "ad_type": "<string>",
      "campaign_name": "<string>",
      "campaign_status": "<string>",
      "budget": 123,
      "budget_type": "<string>",
      "start_date": "<string>",
      "end_date": "<string>",
      "targeting_type": "<string>",
      "bidding_strategy": "<string>",
      "cost_type": "<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,
      "attributed_orders_ntb": 123,
      "attributed_units_ordered_ntb": 123,
      "attributed_sales_ntb": 123,
      "attributed_orders_ntb_percentage": 123,
      "attributed_units_ordered_ntb_percentage": 123,
      "attributed_sales_ntb_percentage": 123,
      "attributed_detail_page_views_clicks": 123,
      "acos": 123,
      "click_through_rate": 123,
      "cost_per_click": 123,
      "cost_per_acquisition": 123,
      "conversion_rate": 123,
      "roas": 123
    }
  ],
  "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).

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).

status

enum<string>[]

Filter by campaign status bucket. Repeatable.

Available options:

active,

paused,

archived

customCampaignGroupId

string[]

Filter to campaigns in the given custom campaign group(s). Repeatable (max 10). Groups must belong to the caller and relate to the requested channels.

sortKey

string

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

sortOrder

enum<string>

Sort direction (default desc).

Available options:

asc,

desc

pageIndex

integer

Zero-based page index (default 0).

pageSize

integer

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

Response

Successful operation

data

object[]

Show child attributes

pagination

object

Show child attributes