🍉 Meet Flexmonster Pivot Table & Charts 2.9.Check out all the hot features!
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. Table Sizes Object
    11. Cell Data Object
    12. Chart Data Object
    13. Toolbar Object
    14. Chart Legend Data Object
    15. Share Report Connection 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. getAllHierarchiesAsync
    23. getAllMeasures
    24. getAllMeasuresAsync
    25. getCell
    26. getColumns
    27. getColumnsAsync
    28. getCondition
    29. getFilter
    30. getFlatSort
    31. getFormat
    32. getMeasures
    33. getMeasuresAsync
    34. getMembers
    35. getMembersAsync
    36. getOptions
    37. getReport
    38. getReportFilters
    39. getReportFiltersAsync
    40. getRows
    41. getRowsAsync
    42. getSelectedCell
    43. getSort
    44. getTableSizes
    45. getXMLACatalogs
    46. getXMLACatalogsAsync
    47. getXMLACubes
    48. getXMLACubesAsync
    49. getXMLADataSources
    50. getXMLADataSourcesAsync
    51. getXMLAProviderName
    52. getXMLAProviderNameAsync
    53. load
    54. off
    55. on
    56. open
    57. openCalculatedValueEditor
    58. openFieldsList
    59. openFilter
    60. print
    61. refresh
    62. removeAllCalculatedMeasures
    63. removeAllConditions
    64. removeCalculatedMeasure
    65. removeCondition
    66. removeSelection
    67. runQuery
    68. save
    69. scrollToColumn
    70. scrollToRow
    71. setFilter
    72. setFlatSort
    73. setFormat
    74. setOptions
    75. setReport
    76. setSort
    77. setTableSizes
    78. shareReport
    79. showCharts
    80. showGrid
    81. showGridAndCharts
    82. sortingMethod
    83. sortValues
    84. 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. unauthorizederror
    41. 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
    10. Filter Group Object
  6. MongoDB Connector API
    1. All methods
    2. getSchema
    3. getMembers
    4. getSelectResult
  7. Flexmonster Connector for amCharts
    1. All methods
    2. amcharts.getData
    3. amcharts.getCategoryName
    4. amcharts.getMeasureNameByIndex
    5. amcharts.getNumberOfMeasures
    6. amcharts.getNumberFormatPattern
Table of contents

/members request

[starting from version: 2.8]

A request for all members of the field.

Request

{
   "type": "members",
    "index": string,
   "field": FieldObject,
"filter": FilterObject[] | FilterGroupObject,
    "page": number
}

The request has the following parameters:

  • type — String. The type of the request. In this case, it is "members".
  • index – String. The dataset identifier.
  • fieldField Object. The field whose members should be sent in the response.
  • filter – Array of Filter Objects|Filter Group Object. Filters that should be applied to members. filter is present in the request when multilevel hierarchies are configured in Flexmonster Pivot.
    The filter can be:
  • page – Number. The page number. It can be used to load members by parts. If the response contains pageTotal parameter, additional requests will be performed to load the remaining pages. Starts from 0.

Response

{
"members"[]: {
"value": string | number,
"id": string
},
"sorted": boolean,
"page": number,
"pageTotal": number
}

The response has the following parameters:

  • members – Array of objects. It contains all the members. Each member has the following properties:
    • value – String|Number. The member’s value. In the case of a number field, it should be of type number. In the case of a date field, the members should be passed to Flexmonster in the Unix timestamp format, then dates are recognized correctly. For example, the date "2016-02-07" will be 1454803200 in the form of a Unix timestamp.
    • id (optional) – String. The member’s id. Supported only for string fields. If defined, it is used in queries and in responses to identify the member.
  • sorted (optional) – Boolean. If true, the members’ order from the response will be used as AZ order on the UI.
  • page (optional) – Number. The current page number. Starts from 0.
  • pageTotal (optional) – Number. The total number of pages. It can be used to load members by parts.

Examples

  1. Example with a string field
    Request:
    {
        "index": "data-set-123",
        "type": "members",
        "field": {
           "uniqueName": "city"
        },
        "page": 0
    }
    Response:
    {
        "members": [
            { "value": "Toronto" }, 
            { "value": "Montreal" }, 
            { "value": "New York" }
        ]
    }
  2. Example with a number field
    Request:
    {
        "index": "data-set-123",
        "type": "members",
        "field": {
           "uniqueName": "price"
        },
        "page": 0
    }
    Response:
    {
        "members": [
            { "value": 10 }, 
            { "value": 28 }, 
            { "value": 30 }
        ]
    }
  3. Example with a date field
    Request:
    {
        "index": "data-set-123",
        "type": "members",
        "field": {
           "uniqueName": "order_date"
        },
        "page": 0
    }
    Response:
    {
        "members": [
            { "value": 1562889600000 }, 
            { "value": 1564617600000 }, 
            { "value": 1564963200000 }
        ]
    }

See also

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