Аналитика
GET /api/partners/bi/chats/
🔒 bot-key или OAuth
Кратко: Получить список чатов для аналитики (BI).
Параметры запроса:
limit(integer, опциональный) — кол-во элементов на странице (макс. 500)offset(integer, опциональный) — кол-во элементов для пропускаid(integer, опциональный) — фильтр по числовому ID чатаstatus_changed_from(string, date-time, опциональный) — дата последнего изменения статуса (начало)status_changed_to(string, date-time, опциональный) — дата последнего изменения статуса (конец)updated_at_from(string, date-time, опциональный) — дата последнего изменения (начало)updated_at_to(string, date-time, опциональный) — дата последнего изменения (конец)
Возвращает: 200 OK — постраничный список объектов CHChat.
Ошибки: 401 — ошибка авторизации.
Пример запроса:
GET /api/partners/bi/profiles/
🔒 bot-key или OAuth
Кратко: Получить список клиентов для аналитики (BI).
Параметры запроса:
limit(integer, опциональный) — кол-во элементов на странице (макс. 500)offset(integer, опциональный) — кол-во элементов для пропускаid(integer, опциональный) — фильтр по числовому ID профиляcreated_at_from(string, date-time, опциональный) — дата создания (начало)created_at_to(string, date-time, опциональный) — дата создания (конец)updated_at_from(string, date-time, опциональный) — дата обновления (начало)updated_at_to(string, date-time, опциональный) — дата обновления (конец)
Возвращает: 200 OK — постраничный список объектов CHCustomerProfile: id, uuid, full_name, phone_number, external_id, email, timezone, created_at, updated_at, tags, attrs.
Ошибки: 401 — ошибка авторизации.
Пример запроса:
GET /api/partners/bi/profiles/snapshot/
🔒 bot-key или OAuth
Кратко: Получить снимок данных по клиентам: общее количество и количество активных за период.
Что делает: Возвращает общее число клиентов бота на момент запроса и количество активных клиентов за указанный период. Период задаётся через date_from/date_to (максимум 31 день) или через одну дату date.
Параметры запроса:
date(string, date, опциональный) — конкретная дата в форматеYYYY-MM-DD(вместоdate_from/date_to)date_from(string, date, опциональный) — начало периода в форматеYYYY-MM-DDdate_to(string, date, опциональный) — конец периода в форматеYYYY-MM-DDtimezone(string, опциональный) — часовая зона (по умолчаниюEurope/Moscow)
Возвращает: 200 OK:
customers_total(integer) — общее кол-во клиентов на момент запросаcustomers_active_count(array) — активные клиенты за период:date_from,date_to,count
Ошибки: 400 — некорректные параметры дат; 401 — ошибка авторизации.
Пример запроса:
GET /api/partners/bi/sessions/
🔒 bot-key или OAuth
Кратко: Получить список чат-сессий для аналитики (BI).
Параметры запроса:
limit(integer, опциональный) — кол-во элементов на странице (макс. 500)offset(integer, опциональный) — кол-во элементов для пропускаid(integer, опциональный) — фильтр по числовому ID сессииis_automatic(boolean, опциональный) — фильтр по автоматическим сессиямcreated_at_from/created_at_to(string, date-time, опциональный) — диапазон дат созданияupdated_at_from/updated_at_to(string, date-time, опциональный) — диапазон дат обновления
Возвращает: 200 OK — постраничный список объектов CHChatCenterSession с детальной статистикой по каждой сессии: длительность, время первого ответа оператора, среднее время ответа, количество сообщений, NPS и другие метрики.
Ошибки: 401 — ошибка авторизации.
Пример запроса:
POST /api/partners/bi/sessions/reports/
🔒 bot-key или OAuth
Кратко: Сформировать отчёт по сессиям за период и получить его через email или callback.
Что делает: Асинхронно создаёт задачу на выгрузку отчёта. В ответе возвращает task_uuid, по которому можно отслеживать статус. Отчёт отправляется на указанный email и/или передаётся на callback URL.
Тело запроса:
start_at(string, date-time, обязательный) — начало периодаend_at(string, date-time, обязательный) — конец периодаemail(string, опциональный) — email для получения ссылки на отчётcallback_url(string, uri, опциональный) — URL для передачи результата
Возвращает: 201 Created:
task_uuid(uuid) — идентификатор задачи выгрузки
Ошибки: 400 — некорректные параметры; 401 — ошибка авторизации.
Пример запроса:
GET /api/partners/bi/sessions/reports/{task_uuid}/
🔒 bot-key или OAuth
Кратко: Получить статус задачи на выгрузку отчёта по сессиям.
Что делает: Возвращает текущий статус задачи и ссылку на файл отчёта после завершения. Статус задачи и ссылка на файл доступны в течение 7 суток с момента создания.
Параметры пути:
task_uuid(uuid, обязательный) — UUID задачи выгрузки
Возвращает: 200 OK:
complete(integer) — прогресс выполнения (0–100)file_url(string, uri) — ссылка на готовый файл отчёта (после завершения)
Ошибки: 401 — ошибка авторизации; 404 — задача не найдена или истёк срок хранения.
Пример запроса:
Last updated