Retrieve Search Query Performance data at the keyword level for one ASIN (Amazon only)

curl --request GET \
  --url https://mm-api.merchantspring.io/search-query-performance/keywords \
  --header 'x-api-key: <api-key>'

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

fetch('https://mm-api.merchantspring.io/search-query-performance/keywords', 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/search-query-performance/keywords",
  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/search-query-performance/keywords"

	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/search-query-performance/keywords")

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": [
    {
      "searchQuery": "<string>",
      "current": {
        "searchQueryVolume": 123,
        "totalImpressions": 123,
        "impressions": 123,
        "impressionShare": 123,
        "totalClicks": 123,
        "clicks": 123,
        "clickShare": 123,
        "totalCtr": 123,
        "ctr": 123,
        "totalCartAdds": 123,
        "cartAdds": 123,
        "atcRate": 123,
        "totalPurchases": 123,
        "purchases": 123,
        "purchaseShare": 123,
        "totalCvr": 123,
        "cvr": 123,
        "currentRevenue": 123,
        "currencyCode": "<string>",
        "totalOpportunity": 123,
        "opportunity": 123
      },
      "prior": {
        "searchQueryVolume": 123,
        "totalImpressions": 123,
        "impressions": 123,
        "impressionShare": 123,
        "totalClicks": 123,
        "clicks": 123,
        "clickShare": 123,
        "totalCtr": 123,
        "ctr": 123,
        "totalCartAdds": 123,
        "cartAdds": 123,
        "atcRate": 123,
        "totalPurchases": 123,
        "purchases": 123,
        "purchaseShare": 123,
        "totalCvr": 123,
        "cvr": 123,
        "currentRevenue": 123,
        "currencyCode": "<string>",
        "totalOpportunity": 123,
        "opportunity": 123
      }
    }
  ],
  "pagination": {
    "pageIndex": 123,
    "pageSize": 123,
    "count": 123
  },
  "meta": {
    "currency": "<string>",
    "dateRange": {
      "fromDate": "<string>",
      "toDate": "<string>",
      "priorFromDate": "<string>",
      "priorToDate": "<string>"
    }
  }
}

GET

search-query-performance

keywords

Retrieve Search Query Performance data at the keyword level for one ASIN (Amazon only)

curl --request GET \
  --url https://mm-api.merchantspring.io/search-query-performance/keywords \
  --header 'x-api-key: <api-key>'

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

fetch('https://mm-api.merchantspring.io/search-query-performance/keywords', 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/search-query-performance/keywords",
  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/search-query-performance/keywords"

	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/search-query-performance/keywords")

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": [
    {
      "searchQuery": "<string>",
      "current": {
        "searchQueryVolume": 123,
        "totalImpressions": 123,
        "impressions": 123,
        "impressionShare": 123,
        "totalClicks": 123,
        "clicks": 123,
        "clickShare": 123,
        "totalCtr": 123,
        "ctr": 123,
        "totalCartAdds": 123,
        "cartAdds": 123,
        "atcRate": 123,
        "totalPurchases": 123,
        "purchases": 123,
        "purchaseShare": 123,
        "totalCvr": 123,
        "cvr": 123,
        "currentRevenue": 123,
        "currencyCode": "<string>",
        "totalOpportunity": 123,
        "opportunity": 123
      },
      "prior": {
        "searchQueryVolume": 123,
        "totalImpressions": 123,
        "impressions": 123,
        "impressionShare": 123,
        "totalClicks": 123,
        "clicks": 123,
        "clickShare": 123,
        "totalCtr": 123,
        "ctr": 123,
        "totalCartAdds": 123,
        "cartAdds": 123,
        "atcRate": 123,
        "totalPurchases": 123,
        "purchases": 123,
        "purchaseShare": 123,
        "totalCvr": 123,
        "cvr": 123,
        "currentRevenue": 123,
        "currencyCode": "<string>",
        "totalOpportunity": 123,
        "opportunity": 123
      }
    }
  ],
  "pagination": {
    "pageIndex": 123,
    "pageSize": 123,
    "count": 123
  },
  "meta": {
    "currency": "<string>",
    "dateRange": {
      "fromDate": "<string>",
      "toDate": "<string>",
      "priorFromDate": "<string>",
      "priorToDate": "<string>"
    }
  }
}

Authorizations

x-api-key

string

header

required

Query Parameters

channelId

string

required

Channel (store) ID. Must be an Amazon seller or vendor channel.

merchantId

string

required

Merchant ID that owns the channel. URL-encode values containing spaces or '@'.

asin

string

required

ASIN to retrieve the keyword-level breakdown for.

fromDate

integer

required

Unix epoch time (seconds) representing the start of the reporting period. SQP data is only available at monthly granularity, so this is clipped to the start of its containing calendar month; the clipped date is returned as meta.dateRange.fromDate in the response.

toDate

integer

required

Unix epoch time (seconds) representing the end of the reporting period. SQP data is only available at monthly granularity, so this is clipped to the end of its containing calendar month; the clipped date is returned as meta.dateRange.toDate in the response.

priorFromDate

integer

required

Unix epoch time (seconds) representing the start of the comparison period. SQP data is only available at monthly granularity, so this is clipped to the start of its containing calendar month; the clipped date is returned as meta.dateRange.priorFromDate in the response.

priorToDate

integer

required

Unix epoch time (seconds) representing the end of the comparison period. SQP data is only available at monthly granularity, so this is clipped to the end of its containing calendar month; the clipped date is returned as meta.dateRange.priorToDate in the response.

timezone

string

required

IANA timezone identifier used to bucket the date range, for example Australia/Sydney.

pageIndex

integer

default:0

Zero-based page index (default 0).

Required range: x >= 0

pageSize

integer

default:25

Number of results per page (default 25, max 50).

Required range: 1 <= x <= 50

sortKey

enum<string>

default:searchQueryVolume

Field to sort by (default searchQueryVolume).

Available options:

searchQuery,

searchQueryVolume,

totalImpressions,

impressions,

impressionShare,

totalClicks,

clicks,

clickShare,

totalCtr,

ctr,

totalCartAdds,

cartAdds,

atcRate,

totalPurchases,

purchases,

purchaseShare,

totalCvr,

cvr,

currentRevenue,

opportunity

sortOrder

enum<string>

default:desc

Sort direction (default desc).

Available options:

asc,

desc

searchText

string

(Optional) Filter search queries containing this text (case-insensitive).

currency

string

3-letter ISO currency code to convert monetary values into (default USD).

Response

Successful operation

data

object[]

Show child attributes

pagination

object

Show child attributes