project.visibilityindex

project.visibilityindex

Returns the visibility index of the specified project. The visibility index can be compared with competitors stored in the project using the COMPETITORS parameter. Historical values can be retrieved using the DATE parameter. Additionally, results can be filtered by a tag using the TAG parameter.

Result

The result contains the domain for which the visibility index is retrieved (domain), the date of the data collection (date), and the visibility index itself (value). If the competitors parameter is used, it will also return the visibility index of the competitors linked to the project.

GET-Parameters

Parameters (Mandatory)

api_key
STRING
Your personal API key. This key is used to authenticate your requests. You can obtain it here.
project
STRING
Specifies the unique hash used to identify a specific project. This hash can be obtained through the project.overview method.

Parameters (Optional)

date
DATE
Specifies the date for which the visibility index should be retrieved. This allows you to access historical visibility data for the project. The date should be provided in the format YYYY-MM-DD.
competitors
BOOLEAN
Set to TRUE to include visibility comparisons with competitors listed in the project.
tag
STRING
Calculates the visibility index for keywords associated with a specific tag. Only one tag can be used at a time.
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/project.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/project.visibilityindex'

post = {



}

response = requests.post(baseUrl, post)

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


let baseUrl = 'https://api.sistrix.com/project.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

})