Platitun · API · Статистика и рейтинг · Свои покупатели

Свои покупатели

GET /api/v1/clients

Область ключа: stats · только чтение

Сколько у вас постоянных покупателей и когда кончаются их подписки у вас. Покупатели ОБЕЗЛИЧЕНЫ: ни почты, ни ника, ни внутреннего номера — так же, как в кабинете.

API не является обходным путём к тому, что закрыто в интерфейсе: узнать, КТО именно покупал, нельзя ни здесь, ни где-то ещё.

Отбор в адресе

Поле	Тип	Что это
`limit`	`integer`	Сколько записей вернуть. Умолчание 50, предел 200.
`skip`	`integer`	Сколько записей пропустить. Курсора здесь нет: список сведён по покупателям и упорядочен по числу покупок.

Поля ответа

Поле	Тип	Что это
`total`	`integer`	Сколько всего покупателей.
`items[].label`	`string`	Порядковый номер в списке, а не признак человека.
`items[].purchases`	`integer`	Сколько покупок сделал у вас.
`items[].subscriptionEndsAt`	`string\|null`	Когда кончается его ближайшая подписка у вас.
`items[].regular`	`boolean`	Постоянный ли покупатель.

Рядом в этом разделе

GET /api/v1/stats — Статистика продаж
GET /api/v1/rating — Свой рейтинг и его журнал