ai.tracker.competitors

ai.tracker.competitors

Credits: 1/entry returned
Returns a list of competitors for the specified PROJECT, including both the competitors stored in the project settings and additional entities mentioned by the AI across the analyzed prompts. This comparison helps evaluate the project's standing within the AI-generated competitive landscape. The result provides a visindex exclusively for the competitors stored in the project, which quantifies their dominance and relevance in AI responses. For other entities mentioned by the AI, the visindex is returned as 0. Furthermore, the response includes the total number of mentions (mentions) and the count of distinct prompts (prompts) in which each competitor appeared. Use the model parameter to differentiate results between AI models and the limit parameter to adjust the number of competitors returned.

Result

The result contains a list of competitors for a specified project, comparing project-defined competitors with additional entities mentioned by the AI. For project-defined competitors, the result includes the visindex, representing their dominance in AI responses. For all other entities, the visindex is 0. Additionally, the response includes the total number of mentions (mentions) and the count of distinct prompts (prompts) in which each entity appeared.

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 ai.tracker.overview method.

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.
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.tracker.competitors";

$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.tracker.competitors'

post = {



}

response = requests.post(baseUrl, post)

data = response.text
curl https://api.sistrix.com/ai.tracker.competitors \


let baseUrl = 'https://api.sistrix.com/ai.tracker.competitors';

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

})