Need a special offer?Find out if your project fits.
+
All documentation
API reference
  • API Reference for older versions
  • FieldObject

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

    Properties

    {
      "uniqueName": string,
      "interval": string
    }
    Property/Type Description
    uniqueName
    String
    The field's unique name.
    interval
    String
    optional 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.
    This property should not be included in the server's responses.
    Only for fields of the "date" type.

    Example

    Example of the "query" with the FieldObject in the /select request for the flat table:

    "query": {
      "fields": [
        {
          "uniqueName": "country"
        },
        {
          "uniqueName": "city"
        },
        {
          "uniqueName": "price"
        },
        {
          "uniqueName": "quantity"
        },
      ],
      "aggs": {
        "values": [{
          "func": "sum", 
          "field": {
            "uniqueName": "price"
          },
        }, 
        {
          "func": "sum", 
          "field": {
            "uniqueName": "quantity"
          },
        }]
      }
    }

    See also

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