Provides aggregated topic-research metrics for a given search keyword (kw): the total number of topics, the average dialog length (number of conversation turns), the distribution of topics across the customer journey stages and the distribution across intent groups. Use ai.topicresearch.list to retrieve the individual topics and ai.topicresearch.topic for a single topic in detail.
Result
The result contains the total number of topics (total_topics), the average dialog length (dialog_length), the distribution per customer journey stage (journey_stages) and per intent group (intents). Each journey stage and intent entry provides its share of the total topics as a percentage (percent).GET-Parameters
Parameters (Mandatory)
api_key
STRING
Your personal API key. This key is used to authenticate your requests. You can obtain it here.
kw
STRING
The search keyword the topic research is based on (e.g. urlaub).
Parameters (Optional)
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.topicresearch.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.topicresearch.overview'
post = {
}
response = requests.post(baseUrl, post)
data = response.textcurl https://api.sistrix.com/ai.topicresearch.overview \
let baseUrl = 'https://api.sistrix.com/ai.topicresearch.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
})
