Получить информацию о сегменте

Описание

Получить подробную информацию о сегменте.

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
format	string	"json"	Нет	Формат возвращаемых данных (по умолчанию – "json")
id	int	1	Нет	Идентификатор сегмента

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

JSON

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

XML

<?xml version="1.0" encoding="UTF-8" ?>
<xml>
  <id>1</id>
  <token>abcdefghijklmnqrstuvwxyz</token>
</xml>

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

JSON

{
  "data": {
    "count": 100,
    "id": 1,
    "name": "Segment A",
    "segment": [
      {
        "condition": "or",
        "limit": 0,
        "list_id": 1,
        "percent_from": 0,
        "percent_to": 99,
        "queries": [
          {
            "child": [],
            "compo": "domaingroup",
            "condition": "",
            "name": "email",
            "operator": "equal",
            "type": "email",
            "value": [
              {
                "name": "domaingroup",
                "value": "Yahoo! (US)"
              }
            ]
          }
        ]
      }
    ]
  },
  "error": 0,
  "error_text": "Successful operation"
}

XML

<?xml version="1.0" encoding="UTF-8" ?>
<xml>
  <data>
    <count>100</count>
    <id>1</id>
    <name>Segment A</name>
    <segment>
      <condition>or</condition>
      <limit>0</limit>
      <list_id>1</list_id>
      <percent_from>0</percent_from>
      <percent_to>99</percent_to>
      <queries>
        <child/>
        <compo>domaingroup</compo>
        <condition>
        </condition>
        <name>email</name>
        <operator>equal</operator>
        <type>email</type>
        <value>
          <name>domaingroup</name>
          <value>Yahoo! (US)</value>
        </value>
      </queries>
    </segment>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
count	int	Количество профилей в сегменте
id	int	Идентификатор сегмента
name	string	Название сегмента
segment	JSON array	Правила сегментации
descr	string	Описание сегмента