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

Описание

Получить список сегментов.

URL-адрес

Метод: POST

https://example.com/api/v1.1/segments/list/

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
format	string	"json"	Нет	Формат возвращаемых данных (по умолчанию – "json")
from_id	int	1	Нет	Идентификатор первого сегмента в списке (по умолчанию – 1)
limit	int	1	Нет	Лимит на количество сегментов в списке (по умолчанию – 1000)
ui_tags	[string]	[ "tag1", "tag2" ]	Нет	Список тегов для поиска (по умолчанию – [])
groups	[string]	[ "group1", "group2" ]	Нет	Список групп для поиска (по умолчанию – [])
groups_id	[int]	[ 0, 1 ]	Нет	Список Id групп для поиска (по умолчанию – [])

Пример запроса

JSON

{
   "token": "abcdefghijklmnqrstuvwxyz",
   "limit": 2
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
   <limit>1</limit>
</xml>

Пример ответа

JSON

{
   "data": [
      {
         "id": 1,
         "name": "Segment A",
         "ui_tags": [
            "tag1",
            "tag2"
         ],
         "Groups": [
            {
               "Id": 1,
               "Name": "subaccount"
            }
         ]
      },
      {
         "id": 2,
         "name": "Segment B",
         "ui_tags": [
 
         ],
         "Groups": [
            {
               "Id": 0,
               "Name": "main"
            }
         ]
      }
   ],
   "error": 0,
   "error_text": "Successful operation",
   "next_from_id": 2
   "total_count": 2
}

XML

<xml>
    <data>
        <groups>
            <id>1</id>
            <name>"subaccount"</name>
        </groups>
        <id>2</id>
        <name>"Женщины в возрасте 35 - 60"</name>
        <ui_tags/>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <next_from_id>5</next_from_id>
    <total_count>9</total_count>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
next_from_id	int	Указатель необходимо передать в следующем запросе для получения еще одной порции данных, до тех пор пока вывод результата не будет содержать 0 строчек истории
total_count	int	Общее количество сегментов
id	int	Идентификатор сегмента
name	string	Название сегмента
ui_tags	[string]	Список тегов
groups	[string]	Список групп