Добавить запрос сегментации
Описание
Добавление нового запроса сегментации к внешней базе данных SQL.
URL-адрес
Метод: POST
https://example.com/api/v1.1/datatables/query_segments/add/
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
name | string | "Main query" | Да | Название запроса |
shortname | string | "query1" | Да | Короткое название запроса |
description | string | "query to the DB" | Нет | Описание запроса |
connector_id | int | 2 | Да | ID коннектора к внешней ДБ |
column | string | "author" | Да | Колонка, используемая для поиска профилей |
sql | string | "SELECT * FROM table" | Нет | SQL-запрос |
cache_time_min | int | 35 | Нет | Время кэширования результата |
groups_id | []int | [ 0, 1 ] | Нет | Список ID групп для поиска<br/>по умолчанию – []<br/> |
parameters | object |
| Нет | Опции пользовательских переменных, используемых в SQL-запросах |
Пример запроса
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"name": "Main Query",
"shortname": "query1",
"sql": "SELECT * FROM table",
"connector_id": 1,
"column": "price"
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<name>Main Query</name>
<shortname>query1uery</shortname>
<sql>SELECT * FROM table</sql>
<connector_id>1</connector_id>
<column>price</column>
</xml>
Пример ответа
- JSON
- XML
{
"data": {
"saved_id": 1
},
"error": 0,
"error_text": "Successful operation",
}
<xml>
<data>
<saved_id>1</saved_id>
</data>
<error>0</error>
<error_text>Successful operation</error_text>t>
</xml>
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
error | int | Код ошибки |
error_text | string | Текст ошибки |
saved_id | int | Идентификатор созданного запроса |