Список сегментов

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

Сохраняйте результаты поиска компаний в именованные списки и сегменты — один раз задайте критерии или отберите контрагентов вручную, затем работайте с готовой подборкой по ID, без повторного ввода фильтров. Статические списки подходят для фиксированных наборов (клиенты, проверенные контрагенты), сегменты на фильтрах — для динамических выборок, которые обновляются при изменении данных.

200 запросов бесплатно
Зарегистрируйтесь и протестируйте API

Формат запроса

GEThttps://api.datanewton.ru/v1/segment
content_copy
Параметры запроса
key
string

API-ключ для авторизации

Пример:
content_copy
Пример запроса
https://api.datanewton.ru/v1/segment?key=mi76aFMdgvml
content_copy

Формат ответа

Успешный ответ
tags
array[object]

Набор сегментов пользователя

id
integer<int64>
name
string

Название сегмента

details
string

Описание/комментарий

created_at
string<date-time>

Дата создания

updated_at
string<date-time>

Дата обновления

count
integer<int32>

Количество контрагентов в сегменте

order_num
integer<int32>

порядковый номер

reserved
boolean

Признак того, что сегмент зарезервирован и не может быть удален/переименован

color
string

Цвет сегмента

tag_type
string

Тип сегмента: static, filter_based

Возможные значения:
filter_config
string

JSON конфигурация фильтра (для filter_based сегментов)

last_materialized_at
string<date-time>

Дата последней материализации

materialization_status
string

Статус материализации: not_started, in_progress, completed, failed

Возможные значения:
materialized_count
integer<int64>

Количество обработанных записей при материализации

search_after_cursor
string

Курсор для продолжения материализации (search_after)

total_count_estimate
integer<int64>

Оценочное общее количество записей

auto_refresh
boolean

Автоматически обновлять сегмент

refresh_schedule
string

Расписание обновления: daily, weekly, monthly

Возможные значения:
static
boolean
filter_based
boolean
content_copy

Песочница

Тестовый ключ доступа:

К тестовому ключу также применяются ограничения стандартных ключей API. С помощью тестового ключа можно делать запросы по ограниченному списку ИНН и ОГРН(-ИП):

ИНН
ОГРН(-ИП)