Get Free Trial
API reference
Table of contents

FieldObject

An object widely used in custom data source API requests. Represents a field with its properties.

The FieldObject has the following parameters:

  • uniqueName – String. The field’s unique name.
  • interval optional – String. A date’s aggregation interval to group dates on the server. The component will automatically send it in /members and /select requests. Possible values depend on how the server handles date intervals. Only for fields of the "date" type.

Example

An example of the request with the FieldObject:

{
    "uniqueName": string,
    "interval": string
}

See also

/handshake request
/fields request
/members request
/select request for pivot table
/select request for flat table
/select request for drill-through view