ai.entity.overview

ai.entity.overview

Credits: 10
Provides an overview of the selected ENTITY, including key visibility metrics and usage statistics. The overview shows visibility values for all AI models as well as for individual models. Additional information includes counts such as the total number of prompts. The lang parameter can be used to define the language in which the results are returned.

Result

The result contains visibility and usage metrics for the specified entity. Each entry includes the visibility index values across all AI models and for individual models (visindex), as well as the total number of prompts (prompt_count).

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)

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.
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.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/ai.entity.overview'

post = {



}

response = requests.post(baseUrl, post)

data = response.text
curl https://api.sistrix.com/ai.entity.overview \


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

})