Skip to main content
GET
/
insights
Get customer insights
curl --request GET \
  --url https://api.open.cx/insights \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "org_id": "<string>",
      "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "content": "<string>",
      "sentiment": "POSITIVE",
      "category": "<string>",
      "user_story": "<string>",
      "occurrence_count": 123,
      "is_resolved": 123,
      "resolved_at": "<string>",
      "resolved_by": 123,
      "is_snoozed": 123,
      "snoozed_at": "<string>",
      "snoozed_by": 123,
      "created_at": "<string>",
      "updated_at": "<string>",
      "last_seen_at": "<string>",
      "deep_research": "<string>",
      "generating_deep_research": 123,
      "sessions": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    }
  ],
  "total": 123,
  "page": 123,
  "totalPages": 123
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
type
enum<string>
Available options:
FEEDBACK,
BUG,
FEATURE_REQUEST,
QUOTE
​
status
enum<string>
Available options:
new,
reviewed,
archived,
all,
handed_off,
snoozed
​
sentiment
enum<string>
Available options:
POSITIVE,
NEGATIVE,
NEUTRAL
​
sortBy
enum<string>
default:occurrence_count
Available options:
created_at,
updated_at,
occurrence_count
​
sortOrder
enum<string>
default:desc
Available options:
asc,
desc
​
page
number
default:1
Required range: x >= 1
​
limit
number
default:20
Required range: 1 <= x <= 100
​
fromDate
string<date-time>
​
toDate
string<date-time>
​
updatedAfter
string<date-time>

Filter insights updated after this date

​
updatedBefore
string<date-time>

Filter insights updated before this date

​
sessionFromDate
string<date-time>
​
sessionToDate
string<date-time>
​
sessionId
string<uuid>
​
groupId
string<uuid>
​
minSessions
number
​
language
string
​
customData
object[]
​
contactCustomData
object[]
​
search
string
​
includeSessionIds
boolean
default:false

Include array of session IDs that contributed to each insight, might slow or block the request if there are many sessions.

Response

Successfully retrieved customer insights

​
data
object[]
required
​
total
number
required
​
page
number
required
​
totalPages
number
required