Получить список запросов на сегментацию
Описание
Получить список запросов на сегментацию.
URL-адрес
Метод: POST
https://example.com/api/v1.1/datatables/query_segments/list
Параметры запроса
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
| format | string | "json" | Нет | Формат возвращаемых данных по умолчанию – "json" |
| from_id | int | 1 | Нет | Идентификатор первой кампании в ответе по умолчанию – 1 |
| limit | int | 2 | Нет | Ли мит на количество возвращаемых данных по умолчанию – 1000 |
| groups | []String | [ "group1", "group2" ] | Нет | Список групп для поиска по умолчанию – [] |
| groups_id | []int | [ 0, 1 ] | Нет | Список Id групп для поиска по умолчанию – [] |
Пример запроса
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz"
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
</xml>
Пример ответа
- JSON
- XML
{
"data": {
"id": 2,
"name": "QueryforextDB",
"shortname": "query",
"description": "External DB segment",
"sql": "SELECT * FROM table",
"connector_id": 1,
"parametrs": {
"name": "variable1",
"title": "var",
"default_value": "low"
},
"cache_time_min": 35
},
"error": 0,
"error_text": "Successful operation",
}
<xml>
<data>
<cache_time_min>35</cache_time_min>
<connector_id>1</connector_id>
<description>External DB segment</description>
<id>2</id>
<name>QueryforextDB</name>
<parametrs>
<default_value>low</default_value>
<name>variable1</name>
<title>var</title>
</parametrs>
<shortname>query</shortname>
<sql>SELECT * FROM table</sql>
</data>
<error>0</error>
<error_text>Successful operation</error_text>
</xml>
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| error | int | Код ошибки |
| error_text | string | Текст ошибки |
| id | int | ID запроса |
| name | string | Название запроса |
| shortname | string | Короткое название запроса |
| description | string | Описание запроса |
| connector_id | int | ID коннектора к внешней ДБ |
| column | string | Колонка, используемая для поиска профилей |
| sql | string | SQL-запрос |
| cache_time_min | int | Время кэширования результата |
| groups_id | []int | Список ID групп для поиска по умолчанию – [] |
| parameters | object | Опции пользовательских переменных, используемых в SQL-запросах |