get

Возвращает данные, введенные пользователями в формы на Турбо-страницах.

  1. Ограничения
  2. Запрос
  3. Ответ

Ограничения

Метод возвращает не более 10 000 объектов.

Запрос

Структура запроса в формате JSON:

{
  "method": "get",
  "params": { /* params */
    "SelectionCriteria": { /* LeadsSelectionCriteria */ 
      "TurboPageIds": [(long), ... ], /* required */
      "DateTimeFrom": (string),
      "DateTimeTo": (string)
    }, /* required */
    "FieldNames": [( "SubmittedAt" | "TurboPageId" | "TurboPageName" | "Id" | "Data" ), ... ], /* required */
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  }
}
Параметр Тип Описание Обяза-тельный
Структура params (для JSON) / GetRequest (для SOAP)
SelectionCriteria LeadsSelectionCriteria

Критерии отбора данных, введенных пользователями в формы на Турбо-страницах.

Да
FieldNames array of LeadFieldEnum Имена параметров верхнего уровня, которые требуется получить. Да
Page LimitOffset

Структура, задающая страницу при постраничной выборке данных.

Нет
Структура LeadsSelectionCriteria
TurboPageIds array of long Отбирать данные, введенные пользователями в формы на Турбо-страницах с указанными идентификаторами. От 1 до 1000 элементов в массиве. Да
DateTimeFrom string Начало периода, за который требуется получить данные. Указывается в формате YYYY-MM-DDThh:mm:ssZ (согласно ISO 8601). Нет
DateTimeTo string Окончание периода, за который требуется получить данные. Указывается в формате YYYY-MM-DDThh:mm:ssZ (согласно ISO 8601). Нет

Ответ

Структура ответа в формате JSON:

{
  "result": { /* result */
    "Leads": [{ /* LeadGetItem */ 
      "Id": (long), /* required */
      "SubmittedAt": (string), /* required */
      "TurboPageId": (string), /* required */
      "TurboPageName": (string), /* required */
      "Data": [{ /* LeadDataItem */ 
        "Name": (string), /* required */
        "Value": (string) /* required */
      }, ... ] /* required */
    }, ... ],
    "LimitedBy": (long)
  }
}
Параметр Тип Описание
Структура result (для JSON) / GetResponse (для SOAP)
Leads array of LeadGetItem Данные, введенные пользователями в формы на Турбо-страницах.
LimitedBy long Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка.
Структура LeadGetItem
Id long Идентификатор данных, введенных пользователем в форму.
SubmittedAt string Дата и время заполнения формы. Выводится в формате YYYY-MM-DDThh:mm:ssZ (согласно ISO 8601).
TurboPageId long Идентификатор Турбо-страницы, на которой заполнена форма.
TurboPageName string

Название Турбо-страницы, на которой заполнена форма.

Data array of LeadDataItem

Данные, введенные пользователем.

Структура LeadDataItem
Name string Название поля формы.
Value string Значение, введенное пользователем.