Get customer insights
Retrieve customer insights (paginated response)
post/insights
Request body
categorystring nullable
Filter by category name
status'all' | 'unresolved' | 'resolved' | 'archived' nullable
sentiment'angry' | 'happy' | 'neutral' nullable
Filter by sentiment
sortBy'occurrence_count' | 'last_seen_at' | 'first_seen_at' | 'created_at' nullable
sortOrder'asc' | 'desc' nullable
minSessionsinteger nullable
Minimum occurrence count
searchstring nullable
Search in insight content
insightNumberinteger nullable
Filter by insight number
sessionLanguage'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' nullable
Filter by language
ticketSentiment'angry' | 'happy' | 'neutral' nullable
Filter by sentiment
channel'web' | 'email' | 'phone_voice' | 'slack' | 'sms' | 'whatsapp' | 'instagram' | 'messenger' | 'api' | 'web_voice'
sessionFromDatestring nullable
Filter sessions created from this date (ISO 8601)
sessionToDatestring nullable
Filter sessions created to this date (ISO 8601)
sessionStatus'closed_resolved' | 'closed_unresolved' | 'open' nullable
Filter by session status
sessionContactIdstring uuid nullable
Filter by session contact ID
ticketCustomDataobject[] nullable
A list of objects with key-value pairs to filter by. Relationship is OR between objects, and AND between the values in each object
contactCustomDataobject[] nullable
Filter by contact custom data key-value pairs
pageinteger
Response
Default Response
pageinteger required
totalinteger required
totalPagesinteger required