TWIN APIРуководстваЛичный кабинет
TWIN API
  1. Analytics API
  2. Chat Statistics

Чат-сессии с сообщениями, операторами и результатами

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

Параметры и результат соответствуют /statistics/chat/sessions. Неизвестные поля и сортировки возвращают 400. Счётчики и цена включают все сообщения выбранной сессии. Содержимое messages и replyTo ограничено разрешёнными компаниями. fromServiceDb влияет на дополнительные данные сессии и не гарантирует актуальность всех полей.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Поля через запятую; пустое или отсутствующее значение выбирает все доступные поля. Дополнительно поддерживаются results-* с путём через точку, например results-crm.email.

string

Поля через запятую; - перед полем задаёт DESC, + или отсутствие префикса — ASC. По умолчанию startedAt по возрастанию.

boolean
Defaults to false

Исключить items из JSON.

boolean
Defaults to false

Исключить count из JSON.

integer
≤ 1000
Defaults to 10

Число строк: модуль целой части числового значения. По умолчанию 10; максимум для JSON — 1000. Значение 0 возвращает пустой список.

integer

Номер страницы: модуль целой части числового значения. При заданном offset номер страницы не используется.

integer

Число пропускаемых строк: модуль целой части числового значения. Имеет приоритет над page.

integer
Defaults to 0

Смещение UTC в минутах; при отсутствии используется X-User-Time-Offset.

string | null

Включительная граница периода. Принимает дату или дату и время, включая смещение UTC и микросекунды; null не ограничивает период.

string | null

Включительная граница периода. Принимает дату или дату и время, включая смещение UTC и микросекунды; null не ограничивает период.

string
enum
Defaults to startedAt

Фильтр dateRangeFilterField.

Allowed:
uuid

Фильтр chatId.

uuid

Фильтр sessionId.

string
enum

Фильтр status.

Allowed:
string

Типы через запятую или messengerType[]. Отсутствующий type соответствует WEB.

string
enum

Фильтр operatorType.

Allowed:
companyId
array of int64s

Компании через запятую или companyId[]. Проверяются права доступа.

companyId
boolean
Defaults to false

Фильтр allCompanies.

string
enum

Без параметра возвращается JSON; выгрузка включает все строки.

Allowed:
string

Параметр выгрузки.

boolean
Defaults to false

Архивировать файл.

boolean
Defaults to false

Загрузить файл и вернуть метаданные.

integer

Срок хранения файла в секундах.

string

Язык заголовков; по умолчанию ru.

integer | null

Минимальное число сообщений; применяется только при значении больше 0.

boolean | null

При true требуется хотя бы одно сообщение CLIENT; false не ограничивает выборку.

boolean | null

Добавить время сообщения в messagesAsString.

boolean | null

Требует HUMAN, отсутствующих closed_by_user_id/closed_by_bot_id и равенства времени последнего сообщения клиента и сессии.

string | null

Поиск по имени, messenger userId для цифр и UUID сессии/клиента.

boolean | null

По умолчанию false. При true запрашивает дополнительные данные сессии с учётом последних изменений. Не гарантирует актуальность всех полей.

Headers
integer

Смещение UTC в минутах, если timezone отсутствует.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Invalid input parameters

401

User is not authenticated

403

Invalid user permissions

Updated about 6 hours ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/csv
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Updated about 6 hours ago