Skip to main content
GET
/
v3
/
reports
/
sessions
List Sessions
curl --request GET \
  --url https://api4.kinbox.com.br/v3/reports/sessions \
  --header 'Authorization: Bearer <token>'
{
  "totalCount": 123,
  "data": [
    {
      "id": "<string>",
      "_id": "<string>",
      "operatorMessagesCount": 123,
      "assignedOperatorMessagesCount": 123,
      "botMessagesCount": 123,
      "contactMessagesCount": 123,
      "totalMessagesCount": 123,
      "trails": [
        {}
      ],
      "tags": [
        123
      ],
      "followers": [
        123
      ],
      "scheduledMessages": [
        123
      ],
      "tma": 123,
      "tme": 123,
      "tmp": 123,
      "summary": "<string>",
      "campaignId": "<string>",
      "tmpResetOnNewAssignment": true,
      "mergedFromCustomerId": "<string>",
      "conversation": {},
      "deals": {},
      "call": {},
      "workspaceId": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "lastUpdateAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
number
default:20
required
Required range: 1 <= x <= 500
​
offset
number
default:0
required
Required range: x >= 0
​
sortBy
string
​
sort
object
​
tags
string[]
​
channels
string[]
​
groups
string[]
​
assigned
string[]
​
from
string
​
to
string
​
search
string
​
isFinished
boolean
​
filters
object
​
trails
object[]
​
waiting
boolean
​
inProgress
boolean
​
bots
string[]
​
pending
boolean
​
hasRating
boolean
​
isNewContact
boolean
​
onlyFinishedAt
boolean
​
onlyCreatedAt
boolean
​
answeredOnDay
boolean
​
isReopened
boolean
​
tmaExists
boolean
​
tmeExists
boolean
​
hasDeal
boolean
​
isConversationOnPeriod
boolean
​
hasWonDeal
boolean
​
tmpExists
boolean
​
changeAssignmentToTrail
boolean
​
campaignId
string
​
conversationId
string
​
contactPhone
string
​
period
enum<string>
Available options:
today,
week,
month,
year,
last_year,
last_month,
last_3_months,
last_1h,
last_3h,
last_24h,
custom
​
periodMetric
string
​
periodFrom
string
​
periodTo
string

Response

200 - application/json
​
totalCount
number

Total de registros

​
data
object[]