Chat session list

get

https://analyse.twin24.ai/api/v1/statistics/chat/sessions

Use this endpoint to get list of chat sessions.

Query Params

withoutCount

boolean

Defaults to false

Determines whether to return the total number of records.

withoutItems

boolean

Defaults to false

Determines whether to return the record list.

limit

integer

Defaults to 10

Maxium number of returning records.

offset

integer

Starting point to return records from a result set.

page

integer

Page number, used to paginate over all records.

fields

string

Comma-separated list of a record's fields to be fetched. Available fields: transactionDate, personalAccountId, companyId, companyName, amount, purpose, externalId, payerNameFromTransaction

output

string

enum

Determines the output format. CSV_EXCEL format includes UTF-8 BOM and semicolon delimiter for better Excel compatibility.

Allowed:

filename

string

Base filename (without extension) to be downloaded.

archive

boolean

Determines whether the zip archive should be returned.

from

string

The start date (for example, 2018-05-27T21:30:54+00:00). (For get request need encode url)

string

The end date (for example, 2018-05-27T21:30:54+00:00). (For get request need encode url)

dateRangeFilterField

string

Date range field. (createdAt, updatedAt)

sessionId

string

Chat session identifier.

sort

string

Comma-separated list of fields to sort by. Each sort field can have special prefix indicating a desirable sort order: + (ascending order, default) or - (descending order). The available sort fields: started_at, name.

chatId

string

The chat identifier.

messengerType

string

enum

Comma-separated list of messenger types.

minMessageCount

integer

Minimal number of chat messages in a session.

hasClientMessages

boolean

Sessions only has client messages.

keyword

string

Search keyword to match session name, clientId, whatsapp number or telegram client Id.

operatorType

string

enum

Filter by operator type.

Allowed:

companyId

integer

The company identifier.

allCompanies

boolean

Show all supervised companies.

Responses

400

Invalid input parameters

401

User is not authenticated

200Success

5XXUnexpected error