marketplace.visibility.list

marketplace.visibility.list

Credits: 1
The function marketplace.visibility.list returns the total visibility index for the products specified in the list. You can filter the results by historical data, as well as by organic and sponsored visibility.

Result

The result contains the date for which the visibility index applies (date) and the value representing the visibility index (value).

GET-Parameters

Parameters (Mandatory)

api_key
STRING
Your personal API key. This key is used to authenticate your requests. You can obtain it here.
hash
STRING
Specifies the unique product list hash used to identify a specific SISTRIX product list. The hash can be retrieved from the URL in the SISTRIX Toolbox.

Parameters (Optional)

country
STRING / countrycode
Defines the country for which the method will be executed. You can find a list of available marketplace country codes here. If no country parameter is provided, the default country is 'de'.
type
STRING
Specifies the type of visibilityindex to retrieve. Available options include organic, sponsored, or global (which combines both organic and sponsored results). If no type is specified, the default setting is organic.
date
DATE
To retrieve a single historical data point, use the date parameter. The date should be provided in the ISO 8601 format (YYYY-MM-DD).
vi_type
STRING
Using the values "seller" and "brand", you can specify whether the visibility index should be calculated based on sellers or brands.
format
STRING
Specifies whether the response will be returned in XML or JSON format. By default, the result will be in XML format.
To be able to use the API documentation with real data, you have to create an API key in your account.
EXAMPLE
$baseUrl = "https://api.sistrix.com/marketplace.visibility.list";

$post = [



];

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, $baseUrl);

curl_setopt($curl, CURLOPT_POSTFIELDS, $post);

curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

$response = curl_exec($curl);

curl_close($curl);
import requests

baseUrl = 'https://api.sistrix.com/marketplace.visibility.list'

post = {



}

response = requests.post(baseUrl, post)

data = response.text
curl https://api.sistrix.com/marketplace.visibility.list \


let baseUrl = 'https://api.sistrix.com/marketplace.visibility.list';

let form = new FormData();



fetch(baseUrl, {

    method: 'POST',

    body: form

}).then(function(response){

    return response.text();

}).then(function(data){

    //data contains the results of the request

})