Skip to main content
POST
Get customer insights

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
category
string | null

Filter by category name

status
enum<string> | null
default:all
Available options:
all,
unresolved,
resolved,
archived
sentiment
enum<string> | null

Filter by sentiment

Available options:
angry,
happy,
neutral
sortBy
enum<string> | null
default:occurrence_count
Available options:
occurrence_count,
last_seen_at,
first_seen_at,
created_at
sortOrder
enum<string> | null
default:desc
Available options:
asc,
desc
minSessions
integer | null

Minimum occurrence count

Required range: 0 < x <= 9007199254740991
search
string | null

Search in insight content

teamId

Filter by specific team ID or none for unassigned insights

Pattern: ^([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)$
insightNumber
integer | null

Filter by insight number

Required range: 0 < x <= 9007199254740991
sessionLanguage
enum<string> | null

Filter by language

Available options:
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
ticketSentiment
enum<string> | null

Filter by sentiment

Available options:
angry,
happy,
neutral
channel
enum<string> | null

Filter by session channel

Available options:
web,
email,
phone_voice,
slack,
sms,
whatsapp,
instagram,
messenger,
api,
web_voice
sessionFromDate
string | null

Filter sessions created from this date (ISO 8601)

sessionToDate
string | null

Filter sessions created to this date (ISO 8601)

sessionStatus
enum<string> | null

Filter by session status

Available options:
closed_resolved,
closed_unresolved,
open
sessionContactId
string<uuid> | null

Filter by session contact ID

Pattern: ^([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)$
ticketCustomData
object[] | null

A list of objects with key-value pairs to filter by. Relationship is OR between objects, and AND between the values in each object

contactCustomData
object[] | null

Filter by contact custom data key-value pairs

page
integer
default:1
Required range: x <= 9007199254740991

Response

Default Response

data
object[]
required
page
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
total
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
totalPages
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991