We have updated Flexmonster Software License Agreement, effective as of September 30, 2025 (list of changes)
Get Free Trial
Get Free Trial
All documentation
API reference
Objects
Methods
Events
Custom data source API
  1. All requests
  2. /handshake request
  3. /fields request
  4. /members request
  5. /select request for the pivot table
  6. /select request for the flat table
  7. /select request for the drill-through view
    8. Objects used in the requests and responses
    1. AggregatedDataObject
    2. FieldInfoObject
    3. FieldObject
    4. FilterConfigObject
    5. FilterGroupObject
    6. FilterObject
    7. MemberFilterObject
    8. MemberInfoObject
    9. ValueObject
MongoDB Connector API
Chart connectors

FieldObject

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

Properties

{
  uniqueName: string,
  interval: string
}
Property/TypeDescription
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