curl --request POST \
--url http://localhost:8080/insights \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"category": "<string>",
"status": "all",
"sortBy": "occurrence_count",
"sortOrder": "desc",
"minSessions": 4503599627370495,
"search": "<string>",
"teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"insightNumber": 4503599627370495,
"sessionFromDate": "<string>",
"sessionToDate": "<string>",
"sessionContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ticketCustomData": [
{}
],
"contactCustomData": [
{}
],
"page": 1
}
'import requests
url = "http://localhost:8080/insights"
payload = {
"category": "<string>",
"status": "all",
"sortBy": "occurrence_count",
"sortOrder": "desc",
"minSessions": 4503599627370495,
"search": "<string>",
"teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"insightNumber": 4503599627370495,
"sessionFromDate": "<string>",
"sessionToDate": "<string>",
"sessionContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ticketCustomData": [{}],
"contactCustomData": [{}],
"page": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
category: '<string>',
status: 'all',
sortBy: 'occurrence_count',
sortOrder: 'desc',
minSessions: 4503599627370495,
search: '<string>',
teamId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
insightNumber: 4503599627370495,
sessionFromDate: '<string>',
sessionToDate: '<string>',
sessionContactId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
ticketCustomData: [{}],
contactCustomData: [{}],
page: 1
})
};
fetch('http://localhost:8080/insights', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/insights",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'category' => '<string>',
'status' => 'all',
'sortBy' => 'occurrence_count',
'sortOrder' => 'desc',
'minSessions' => 4503599627370495,
'search' => '<string>',
'teamId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'insightNumber' => 4503599627370495,
'sessionFromDate' => '<string>',
'sessionToDate' => '<string>',
'sessionContactId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'ticketCustomData' => [
[
]
],
'contactCustomData' => [
[
]
],
'page' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/insights"
payload := strings.NewReader("{\n \"category\": \"<string>\",\n \"status\": \"all\",\n \"sortBy\": \"occurrence_count\",\n \"sortOrder\": \"desc\",\n \"minSessions\": 4503599627370495,\n \"search\": \"<string>\",\n \"teamId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"insightNumber\": 4503599627370495,\n \"sessionFromDate\": \"<string>\",\n \"sessionToDate\": \"<string>\",\n \"sessionContactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ticketCustomData\": [\n {}\n ],\n \"contactCustomData\": [\n {}\n ],\n \"page\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8080/insights")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"category\": \"<string>\",\n \"status\": \"all\",\n \"sortBy\": \"occurrence_count\",\n \"sortOrder\": \"desc\",\n \"minSessions\": 4503599627370495,\n \"search\": \"<string>\",\n \"teamId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"insightNumber\": 4503599627370495,\n \"sessionFromDate\": \"<string>\",\n \"sessionToDate\": \"<string>\",\n \"sessionContactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ticketCustomData\": [\n {}\n ],\n \"contactCustomData\": [\n {}\n ],\n \"page\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/insights")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"category\": \"<string>\",\n \"status\": \"all\",\n \"sortBy\": \"occurrence_count\",\n \"sortOrder\": \"desc\",\n \"minSessions\": 4503599627370495,\n \"search\": \"<string>\",\n \"teamId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"insightNumber\": 4503599627370495,\n \"sessionFromDate\": \"<string>\",\n \"sessionToDate\": \"<string>\",\n \"sessionContactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ticketCustomData\": [\n {}\n ],\n \"contactCustomData\": [\n {}\n ],\n \"page\": 1\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"insight_number": 0,
"content": "<string>",
"sentiment": "angry",
"occurrence_count": 0,
"category": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>"
},
"team": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"resolved_by": {
"name": "<string>",
"avatar_url": "<string>"
},
"resolved_at": "2023-11-07T05:31:56Z",
"archived_by": {
"name": "<string>",
"avatar_url": "<string>",
"reason": "<string>"
},
"archived_at": "2023-11-07T05:31:56Z",
"archive_policy": "forever",
"resurface_progress": {
"current": 0,
"target": 0
},
"deep_research": "<string>",
"deep_research_completed_at": "2023-11-07T05:31:56Z",
"first_seen_at": "2023-11-07T05:31:56Z",
"last_seen_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"page": 0,
"total": 0,
"totalPages": 0
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Get customer insights
Retrieve every customer insight the AI has surfaced, paginated. Use when driving the customer insights categorisation workflow from external code.
curl --request POST \
--url http://localhost:8080/insights \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"category": "<string>",
"status": "all",
"sortBy": "occurrence_count",
"sortOrder": "desc",
"minSessions": 4503599627370495,
"search": "<string>",
"teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"insightNumber": 4503599627370495,
"sessionFromDate": "<string>",
"sessionToDate": "<string>",
"sessionContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ticketCustomData": [
{}
],
"contactCustomData": [
{}
],
"page": 1
}
'import requests
url = "http://localhost:8080/insights"
payload = {
"category": "<string>",
"status": "all",
"sortBy": "occurrence_count",
"sortOrder": "desc",
"minSessions": 4503599627370495,
"search": "<string>",
"teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"insightNumber": 4503599627370495,
"sessionFromDate": "<string>",
"sessionToDate": "<string>",
"sessionContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ticketCustomData": [{}],
"contactCustomData": [{}],
"page": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
category: '<string>',
status: 'all',
sortBy: 'occurrence_count',
sortOrder: 'desc',
minSessions: 4503599627370495,
search: '<string>',
teamId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
insightNumber: 4503599627370495,
sessionFromDate: '<string>',
sessionToDate: '<string>',
sessionContactId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
ticketCustomData: [{}],
contactCustomData: [{}],
page: 1
})
};
fetch('http://localhost:8080/insights', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/insights",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'category' => '<string>',
'status' => 'all',
'sortBy' => 'occurrence_count',
'sortOrder' => 'desc',
'minSessions' => 4503599627370495,
'search' => '<string>',
'teamId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'insightNumber' => 4503599627370495,
'sessionFromDate' => '<string>',
'sessionToDate' => '<string>',
'sessionContactId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'ticketCustomData' => [
[
]
],
'contactCustomData' => [
[
]
],
'page' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/insights"
payload := strings.NewReader("{\n \"category\": \"<string>\",\n \"status\": \"all\",\n \"sortBy\": \"occurrence_count\",\n \"sortOrder\": \"desc\",\n \"minSessions\": 4503599627370495,\n \"search\": \"<string>\",\n \"teamId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"insightNumber\": 4503599627370495,\n \"sessionFromDate\": \"<string>\",\n \"sessionToDate\": \"<string>\",\n \"sessionContactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ticketCustomData\": [\n {}\n ],\n \"contactCustomData\": [\n {}\n ],\n \"page\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8080/insights")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"category\": \"<string>\",\n \"status\": \"all\",\n \"sortBy\": \"occurrence_count\",\n \"sortOrder\": \"desc\",\n \"minSessions\": 4503599627370495,\n \"search\": \"<string>\",\n \"teamId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"insightNumber\": 4503599627370495,\n \"sessionFromDate\": \"<string>\",\n \"sessionToDate\": \"<string>\",\n \"sessionContactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ticketCustomData\": [\n {}\n ],\n \"contactCustomData\": [\n {}\n ],\n \"page\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/insights")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"category\": \"<string>\",\n \"status\": \"all\",\n \"sortBy\": \"occurrence_count\",\n \"sortOrder\": \"desc\",\n \"minSessions\": 4503599627370495,\n \"search\": \"<string>\",\n \"teamId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"insightNumber\": 4503599627370495,\n \"sessionFromDate\": \"<string>\",\n \"sessionToDate\": \"<string>\",\n \"sessionContactId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ticketCustomData\": [\n {}\n ],\n \"contactCustomData\": [\n {}\n ],\n \"page\": 1\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"insight_number": 0,
"content": "<string>",
"sentiment": "angry",
"occurrence_count": 0,
"category": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>"
},
"team": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"resolved_by": {
"name": "<string>",
"avatar_url": "<string>"
},
"resolved_at": "2023-11-07T05:31:56Z",
"archived_by": {
"name": "<string>",
"avatar_url": "<string>",
"reason": "<string>"
},
"archived_at": "2023-11-07T05:31:56Z",
"archive_policy": "forever",
"resurface_progress": {
"current": 0,
"target": 0
},
"deep_research": "<string>",
"deep_research_completed_at": "2023-11-07T05:31:56Z",
"first_seen_at": "2023-11-07T05:31:56Z",
"last_seen_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"page": 0,
"total": 0,
"totalPages": 0
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Filter by category name
all, unresolved, resolved, archived Filter by sentiment
angry, happy, neutral occurrence_count, last_seen_at, first_seen_at, created_at asc, desc Minimum occurrence count
0 < x <= 9007199254740991Search in insight content
Filter by specific team ID or none for unassigned insights
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Filter by insight number
0 < x <= 9007199254740991Filter by language
az, el, de, fr, it, es, pt, nl, da, sv, no, fi, et, is, pl, cs, sk, hu, ro, bg, hr, sr, uk, ru, tr, en, zh, ja, ko, hi, bn, id, ms, th, vi, tl, ar, he, fa, ur, af, sw, ku, ckb, kmr Filter by sentiment
angry, happy, neutral Filter by session channel
web, email, phone_voice, slack, sms, whatsapp, instagram, messenger, api, web_voice, twitter, twitter_mentions, app_review, internal Filter sessions created from this date (ISO 8601)
Filter sessions created to this date (ISO 8601)
Filter by session status
closed_resolved, closed_unresolved, open Filter by session contact ID
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$A list of objects with key-value pairs to filter by. Relationship is OR between objects, and AND between the values in each object
Show child attributes
Show child attributes
Filter by contact custom data key-value pairs
Show child attributes
Show child attributes
x <= 9007199254740991Response
Default Response
Was this page helpful?