Lists all topics found for a given search keyword (kw). Each topic contains its label, a short description, the estimated search volume, the average dialog length, the customer journey stage and the intent. The returned topic_label can be passed as the topic parameter to ai.topicresearch.topic to retrieve the full topic detail. The result can optionally be filtered by intent and journey_stage and paginated via limit and page.
Result
The result contains one topic entry per returned topic, each with topic, description, topic_label, search_volume, dialog_length, journey_stage, intent (the super-intent group) and intent_detail (the fine-grained intent).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). The singular alias keyword is also accepted.
Parameters (Optional)
intent
STRING
Optional filter for the intent. Accepts an intent group (learning, commercial, transactional, informational) or a single raw intent.
journey_stage
STRING
Optional filter for the customer journey stage. One of: awareness, consideration, decision, retention.
limit
INTEGER
Limits the number of returned topics. Defaults to 100 and is capped by the available credits (1 credit per returned topic).
page
INTEGER
The page of results to return, based on the limit. Defaults to 1.
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.list";
$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.list'
post = {
}
response = requests.post(baseUrl, post)
data = response.textcurl https://api.sistrix.com/ai.topicresearch.list \
let baseUrl = 'https://api.sistrix.com/ai.topicresearch.list';
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
})
