ai.tracker.prompts

Credits: 1/entry returned
Returns a list of all prompts stored in the specified PROJECT. This endpoint provides a detailed breakdown of how each prompt performs across different AI models and whether the target brand was mentioned in the results. The response includes the brand_found indicator and the average position (avg_pos) if the brand was mentioned by the AI. Additionally, the tags attribute displays the categories assigned to each prompt within the project. The nested models section shows the availability and status of each prompt across various AI platforms (e.g., ChatGPT, Perplexity, AIO). Use the limit parameter to control the number of returned prompts and the project parameter to specify the source.

Result

The result contains the list of predefined prompts associated with a specific project. Each entry includes the fixed query string (prompt), performance metrics regarding brand visibility (brand_found, avg_pos), and the tags (tags) assigned to the prompt within the project settings.

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)

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.prompts";
$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.prompts'
post = {

}
response = requests.post(baseUrl, post)
data = response.text
curl https://api.sistrix.com/ai.tracker.prompts \
let baseUrl = 'https://api.sistrix.com/ai.tracker.prompts';
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
})