Creates a list of hosts and their degree of similarity (%) with the given ENTITY. The match indicates how closely each host’s AI profile aligns with that of the specified entity. The number of displayed hosts can be modified with the limit parameter. Further modifications can be made using the mode and lang parameters, which change the model and language used for the comparison.
Result
The result contains a list of hosts that are most similar to the specified entity. Each host entry includes the host name (brand), the visibility index (visindex), the share of results for the selected AI model (count_share), and the similarity percentage (competition). Additionally, the response shows the number of credits used for the request.GET-Parameters
Parameters (Mandatory)
api_key
STRING
Your personal API key. This key is used to authenticate your requests. You can obtain it here.
entity
STRING
In the context of AI analysis, an entity is a clearly identifiable object or concept mentioned within a text. This can include companies or brands (e.g., SISTRIX, Nike), people (e.g., Angela Merkel), places (e.g., Berlin, New York), or products and services (e.g., Toolbox, iPhone).
Parameters (Optional)
model
STRING
Defines the model for which the method will be executed. If no model is specified, results for all AI models will be returned. This can also be explicitly set by using the value all.
lang
STRING
Defines the language in which the results will be returned. The parameter follows ISO 639 (German = de). If no language is specified, the default Toolbox language will be used.
limit
INTEGER
Specifies the number of reults for each page. Adjust this value to control the number of results returned on each page. By default, this parameter is set to 100.
page
INTEGER
Specifies which set of recources to return. This allows you to choose a specific page of results, with the number of results for each page determined by the limit parameter.
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/ai.entity.sources";
$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/ai.entity.sources'
post = {
}
response = requests.post(baseUrl, post)
data = response.textcurl https://api.sistrix.com/ai.entity.sources \
let baseUrl = 'https://api.sistrix.com/ai.entity.sources';
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
})
