ai.check.overview

ai.check.overview

Credits: 10
Provides an overview of the AI visibility for the given BRANDS and/or DOMAINS. If only brands are provided, the result covers mentions (how often the brands appear in AI answers). If only domains are provided, the result covers citations (how often the domains are cited as sources). If both are provided, a combined analysis is returned. Brands and domains are passed directly by the caller — either as a single value or as a JSON array of up to 100 entries per parameter. The country parameter can be used to define the country for which the results are returned.

Result

The result contains the analysed scope (mentions, citations or combined), the total number of prompts (prompt_count), a breakdown of the prompt count per AI model (models) and a breakdown per country (countries).

GET-Parameters

Parameters (Mandatory)

api_key
STRING
Your personal API key. This key is used to authenticate your requests. You can obtain it here.

Parameters (Optional)

brands
STRING
One or more brand names to analyse for AI mentions. Accepts a single value (e.g. sistrix) or a JSON array of up to 100 brands (e.g. ["sistrix","nike"]). At least one of the brands or domains parameters must be provided. The singular alias brand is also accepted.
domains
STRING
One or more domains to analyse for AI citations. Accepts a single value (e.g. sistrix.de) or a JSON array of up to 100 domains (e.g. ["sistrix.de","sistrix.com"]). At least one of the brands or domains parameters must be provided. The singular alias domain is also accepted.
country
STRING
Defines the country for which the results will be returned. The parameter follows ISO 3166-1 alpha-2 (e.g., Germany = DE). If no country is specified, results for all countries will be displayed.
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.check.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.check.overview'

post = {



}

response = requests.post(baseUrl, post)

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


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

})