get

Returns data entered by users in forms on turbo pages.

  1. Restrictions
  2. Request
  3. Response

Restrictions

The method returns a maximum of 10,000 objects.

Request

Request structure in JSON format:

{
  "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)
    }
  }
}
ParameterTypeDescriptionRequired
Params structure (for JSON) / GetRequest (for SOAP)
SelectionCriteriaLeadsSelectionCriteria

Criteria for selecting data that was entered by users in forms on turbo pages.

Yes
FieldNamesarray of LeadFieldEnumNames of top-level parameters to get.Yes
PageLimitOffset

Structure that defines the page for paginated selection of data.

No
LeadsSelectionCriteria structure
TurboPageIdsarray of longSelect data that was entered by users in forms on turbo pages with the specified IDs. From 1 to 1000 items in the array.Yes
DateTimeFromstringThe start of the time period to get data for. Specified in the format YYYY-MM-DDThh:mm:ssZ (conforming to ISO 8601).No
DateTimeTostringThe end of the time period to get data for. Specified in the format YYYY-MM-DDThh:mm:ssZ (conforming to ISO 8601).No

Response

Response structure in JSON format:

{
  "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)
  }
}
ParameterTypeDescription
Result structure (for JSON) / GetResponse (for SOAP)
Leadsarray of LeadGetItemData entered by users in forms on turbo pages.
LimitedBylongSequential number of the last object returned. It is included if there was a limit on the number of objects in the response. See the section Paginated data selection.
LeadGetItem structure
IdlongID of the data entered by a user in a form.
SubmittedAtstringThe date and time when the form was submitted. Output in the format YYYY-MM-DDThh:mm:ssZ (conforming to ISO 8601).
TurboPageIdlongID of the turbo page where the form was submitted.
TurboPageNamestring

Name of the turbo page where the form was submitted.

Dataarray of LeadDataItem

Data entered by the user.

LeadDataItem structure
NamestringName of the form field.
ValuestringThe value entered by the user.