Returns the current visibility index for the given URL, PATH, DOMAIN, or HOST. The returned values can be customized using a variety of optional parameters. By combining the history, daily, limit, and date parameters, you can retrieve historical visibility index data from the specified source. The mobile and country parameters allow you to adjust the device type and geographic location for the results.
Result
The result contains a JSON or XML array with the visibility index (value) for the supplied domain, along with the domain name (domain) and the date (date) of the measurement. If the daily or history parameter is used, it will contain a list of historical visibility index values, including their corresponding dates.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.
history
BOOLEAN
If set to TRUE, all available historical weekly values are returned. By default, this parameter is set to FALSE, meaning only current data is provided. If history is set to TRUE and the limit parameter is not used to restrict the number of results, all known historical weekly values will be returned.
limit
INTEGER
Limits the number of historical values returned. This parameter only takes effect when used in combination with the history parameter. If history is set to TRUE and Limit is specified, only the number of historical values defined by Limit will be returned. If history is TRUE and Limit is not provided, all available historical values are returned.
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 returns the daily visibilityindex for the last 30 days. This parameter only works when history is set to TRUE and can be limited by the Limit parameter.
date
DATE
Defines a specific date for which the weekly visibility index (SI) will be returned. If no data is available for the given date, the returned value will be NULL.
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";
$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'
post = {
}
response = requests.post(baseUrl, post)
data = response.textcurl https://api.sistrix.com/domain.visibilityindex \
let baseUrl = 'https://api.sistrix.com/domain.visibilityindex';
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
})
