domain.visibilityindex.overview

domain.visibilityindex.overview

Credits: 10
Creates an overview of the highest ever measured visibility index, the lowest visibility index, and the number of weeks taken into account for these results for the given DOMAIN, HOSTNAME, URL, or PATH. With the daily parameter, you can check these peak values for the last 100 days based on daily SI data. Furthermore, you can modify the request by using the mobile parameter to get desktop-based data or by specifying the country with the country parameter to get country-specific data.

Result

The results include the highest visibility index (sichtbarkeitsindex_overview_max) and the lowest visibility index (sichtbarkeitsindex_overview_min), each with its corresponding value (value) and dates (date). Additionally, it provides the time period covered by these values in the sichtbarkeitsindex_overview section, specified by the parameter (weeks).

GET-Parameters

Parameters (Mandatory)

api_key
STRING
Your personal API key. This key is used to authenticate your requests. You can obtain it here.
address_object
STRING
Defines the domain, host, path, or URL to which the method is applied, depending on the key value provided.

Parameters (Optional)

country
STRING / countrycode
Defines the country for which the method will be executed. You can find a list of available country codes here. If no Country parameter is provided, the default country associated with the Toolbox account will be used.
mobile
BOOLEAN
Defines whether mobile or desktop data should be returned. By default, this parameter is set to TRUE, meaning mobile data will be returned. If set to FALSE, only desktop data will be returned.
daily
BOOLEAN
If set to TRUE, the function retrieves the highest and lowest daily visibility index (SI) for the last 100 days, including the current value. The count of days used can be found in the result with the key days.
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/domain.visibilityindex.overview";

$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/domain.visibilityindex.overview'

post = {



}

response = requests.post(baseUrl, post)

data = response.text
curl https://api.sistrix.com/domain.visibilityindex.overview \


let baseUrl = 'https://api.sistrix.com/domain.visibilityindex.overview';

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

})