Despite the COVID-19 outbreak, our team continues operating at full speed. We are always here to support and answer all your questions.

Feel free to reach out by filling this quick form.

Fill the form
Get Free Trial
  1. API reference
    1. Introduction
    2. Flexmonster()
  2. Objects
    1. All objects
    2. Report Object
    3. Data Source Object
    4. Mapping Object
    5. Slice Object
    6. Options Object
    7. Filtering
      1. Filter Object
      2. Number Query Object
      3. String Query Object
      4. Date Query Object
      5. Time Query Object
      6. Value Query Object
    8. Format Object
    9. Conditional Format Object
    10. Cell Data Object
    11. Chart Data Object
    12. Toolbar Object
    13. Chart Legend Data Object
  3. Methods
    1. All methods
    2. addCalculatedMeasure
    3. addCondition
    4. alert
    5. clear
    6. clearFilter
    7. clearXMLACache
    8. closeFieldsList
    9. collapseAllData
    10. collapseData
    11. connectTo
    12. customizeAPIRequest
    13. customizeCell
    14. customizeChartElement
    15. customizeContextMenu
    16. dispose
    17. expandAllData
    18. expandData
    19. exportTo
    20. getAllConditions
    21. getAllHierarchies
    22. getAllMeasures
    23. getCell
    24. getColumns
    25. getCondition
    26. getFilter
    27. getFlatSort
    28. getFormat
    29. getMeasures
    30. getMembers
    31. getOptions
    32. getReport
    33. getReportFilters
    34. getRows
    35. getSelectedCell
    36. getSort
    37. getXMLACatalogs
    38. getXMLACubes
    39. getXMLADataSources
    40. getXMLAProviderName
    41. load
    42. off
    43. on
    44. open
    45. openCalculatedValueEditor
    46. openFieldsList
    47. openFilter
    48. print
    49. refresh
    50. removeAllCalculatedMeasures
    51. removeAllConditions
    52. removeCalculatedMeasure
    53. removeCondition
    54. removeSelection
    55. runQuery
    56. save
    57. setFilter
    58. setFlatSort
    59. setFormat
    60. setOptions
    61. setReport
    62. setSort
    63. showCharts
    64. showGrid
    65. showGridAndCharts
    66. sortingMethod
    67. sortValues
    68. updateData
  4. Events
    1. All events
    2. afterchartdraw
    3. aftergriddraw
    4. beforegriddraw
    5. beforetoolbarcreated
    6. cellclick
    7. celldoubleclick
    8. chartclick
    9. datachanged
    10. dataerror
    11. datafilecancelled
    12. dataloaded
    13. drillthroughclose
    14. drillthroughopen
    15. exportcomplete
    16. exportstart
    17. fieldslistclose
    18. fieldslistopen
    19. filterclose
    20. filteropen
    21. loadingdata
    22. loadinglocalization
    23. loadingolapstructure
    24. loadingreportfile
    25. localizationerror
    26. localizationloaded
    27. olapstructureerror
    28. olapstructureloaded
    29. openingreportfile
    30. printcomplete
    31. printstart
    32. querycomplete
    33. queryerror
    34. ready
    35. reportchange
    36. reportcomplete
    37. reportfilecancelled
    38. reportfileerror
    39. runningquery
    40. update
  5. 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. Field Object
    9. Filter Object
  6. MongoDB Connector API
    1. All methods
    2. getSchema
    3. getMembers
    4. getSelectResult
Table of contents

/select request for the flat table

[starting from version: 2.8]

A request for data.

Request

{
    "type": "select"
    "index": string,
    "query": {
       "fields"[]: FieldObject,
       "filter"[]: FilterObject,
        "aggs": {
            "values"[]: {
                "field": FieldObject,
                "func": string
            }
        }
    },
    "page": number
}

The request has the following parameters:

  • type — String. The type of the request. In this case, it is "select".
  • index – String. The dataset identifier.
  • query – Object. A query object.
    • fields – Array of Field Objects. Array of fields (columns) to include in the response.
    • filter (optional) – Array of Filter Objects. Query filters. The part of a query that specifies which filters should be applied. Each field with a filter is represented by a separate object.
    • aggs (optional) – Array. Query column totals.
      • values – Array. Columns to aggregate totals for.
        Fields that have at least one supported aggregation defined in the schema can be selected for this part of the query.
        • fieldField Object.
        • func – String. Aggregation function name. For each field, the list of supported aggregations is defined in the response to the /fields request. Supported values may include: "sum", "count", "distinctcount", "average", "median", "product", "min", "max", "stdevp", "stdevs", "none". Note: for the fields of the "number" type, Flexmonster Pivot supports built-in front-end aggregations.
  • page – Number. Page number. It can be used to load data by parts. If response contains pageTotal parameter, additional requests will be performed to load the remaining pages. Starts from 0.

Response

{
    "fields"[]: {
        "uniqueName": string
    },
    "hits"[]: [
        (index): string | number
    ],
    "aggs"[]: {
        "values": {
            (uniqueName): {
                (func): number
            }
        }
    },
    "page": number,
    "pageTotal": number
}

The response has the following parameters:

  • fields – Array. Fields (columns) included in the response.
    • uniqueName – String. Field’s unique name.
  • hits – Array. A two-dimensional array containing data.
  • hits[][(index): string | number]. Data row, where (index) is a field (column) index.
  • aggs (optional) – Array. Column totals.
    • values – Object. Numeric values that are calculated for column totals.
      • (uniqueName) – Object. (uniqueName) is a field’s unique name.
        • (func) – Number. Result of the calculation, where (func) is the aggregation function.
  • page (optional) – Number. Current page number. Starts from 0.
  • pageTotal (optional) – Number. The total number of pages. It can be used to load members by parts.

Example

Request:

{
    "index": "data-set-123",
    "type": "select",
    "query": {
        "fields": [
            {
               "uniqueName": "country"
            },
            {
               "uniqueName": "city"
            },
            {
               "uniqueName": "price"
            },
            {
               "uniqueName": "quantity"
            }
        ],
        "aggs": {
            "values": [{
                "func": "sum", 
                "field": {
                   "uniqueName": "price"
                }
            }, {
                "func": "sum", 
                "field": {
                   "uniqueName": "quantity"
                }
            }]
        }
    },
    "page": 0
}

Response:

{
    "fields": [
        { "uniqueName": "country" },
        { "uniqueName": "city" },
        { "uniqueName": "price" },
        { "uniqueName": "quantity" }
    ],
    "hits": [
        ["Canada", "Toronto", 53, 2],
        ["...", "...", 1, 1]
    ],
    "aggs": [{
        "values": {
            "price": {
                "sum": 123
            },
            "quantity": {
                "sum": 5
            }
        }
    }]
}

See also

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