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

Описание

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

URL-адрес

Метод: POST

https://example.com/api/v1.1/datatables/query_segments/get

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
id	int	1	Да, если не указан shortname	ID запроса
shortname	string	"query1"	Да, если не указан id	Короткое название запроса

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

JSON

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

XML

<xml>
  <id>2</id>
  <token>abcdefghijklmnqrstuvwxyz</token>
</xml>

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

JSON

{
    "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

<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-запросах