Сегменты

Сегменты ресторана с числом гостей и охватом рассылки.

Сегменты ресторана с числом гостей и охватом рассылки. Состав сегментов пересчитывается по расписанию; пороги задаёт ресторан в кабинете, через API они не меняются.

Объект segment

Сегмент гостей ресторана

Поле	Тип	Описание
`id`	string	Неизменный id
`object`	string	Тип объекта
`name`	string	Название, как в кабинете; может меняться
`description`	string \| null	Пояснение для человека
`kind`	enum	`rfm` — стандартный сегмент по давности, частоте и чеку; `custom` — настроенный рестораном. Значения: `rfm`, `custom`
`guests_count`	integer	Гостей в сегменте сейчас
`reachable_count`	integer	Сколько получат SMS, если отправить сейчас — без отписавшихся, без телефона и без попавших под частотный лимит ресторана
`updated_at`	datetime	Когда сегмент пересчитан, UTC

{
  "id": "seg_at_risk",
  "object": "segment",
  "name": "Под угрозой ухода",
  "description": "Ходили часто, пропали ~45 дней",
  "kind": "rfm",
  "guests_count": 1830,
  "reachable_count": 1412,
  "updated_at": "2026-10-14T03:00:00Z"
}

Сегменты ресторана

GET /v1/segments · право guests:read

Сегменты с числом гостей и сколько получат SMS, если отправить сейчас. Порядок — по id.

Параметр	Где	Обязателен	Описание	Пример
`limit`	query		Размер страницы, от 1 до 100	`100`
`cursor`	query		`next_cursor` предыдущей страницы; привязан к фильтрам запроса	`c_eyJ2IjpbIjIwMjYtMTAtMTMiXX0`

curl https://app.lazycrm.ru/v1/segments \
  -H "Authorization: Bearer lcrm_live_…"

Ошибки: 400 unknown_parameter, 400 invalid_cursor, 401 missing_api_key, 401 invalid_api_key, 403 insufficient_scope, 422 validation_error, 429 rate_limited, 500 internal_error, 503 upstream_unavailable.

Получить сегмент

GET /v1/segments/{segment_id} · право guests:read

Один сегмент по id из списка сегментов или из segment_ids гостя. Число гостей и охват — на момент последнего пересчёта сегмента (updated_at).

Параметр	Где	Обязателен	Описание	Пример
`segment_id`	путь	да	Id сегмента	`seg_at_risk`

curl https://app.lazycrm.ru/v1/segments/seg_at_risk \
  -H "Authorization: Bearer lcrm_live_…"

Ошибки: 400 unknown_parameter, 401 missing_api_key, 401 invalid_api_key, 403 insufficient_scope, 404 not_found, 429 rate_limited, 500 internal_error, 503 upstream_unavailable.