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

Описание

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

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

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

XML

<?xml version="1.0" encoding="UTF-8" ?>
<xml>
  <limit>1</limit>
  <token>abcdefghijklmnqrstuvwxyz</token>
</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 version="1.0" encoding="UTF-8" ?>
<xml>
  <data>
    <id>1</id>
    <name>Segment A</name>
    <ui_tags>tag1</ui_tags>
    <ui_tags>tag2</ui_tags>
    <Groups>
      <Id>1</Id>
      <Name>subaccount</Name>
    </Groups>
  </data>
  <data>
    <id>2</id>
    <name>Segment B</name>
    <ui_tags/>
    <Groups>
      <Id>0</Id>
      <Name>main</Name>
    </Groups>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <next_from_id>2</next_from_id>
  <total_count>2</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	Список групп