Dear visitor, despite the COVID-19 outbreak, our team continues operating at full speed.

Also, here is the form where you can apply for a special discount and we will contact you with possible options. Stay safe and continue achieving your business goals.

Fill the form
Get Free Trial
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

/members request

[starting from version: 2.8]

A request for all members of the field.

Request

{
    "type": "members"
    "index": string,
    "field": FieldObject,
    "page": number
}

Request has the following parameters:

  • fieldField Object.
  • page – Number. 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
},
"filter": FilterObject,
"sorted": boolean,
"page": number,
"pageTotal": number
}

Response has the following parameters:

  • members – Array of objects. It contains all the members.
    • value – String|Number. Member’s value. In case of a number field it should be of type number. In the case of a date field, it should be Unix timestamp.
    • id (optional) – String. Member’s id. Supported only for string fields. If defined, it is used in queries and in responses to identify the member.
  • filter (optional) – Filter Object. It specifies which filters should be applied to members. Note: for the /members request, only include and exclude parameters of the Filter Object are used.
  • sorted (optional) – Boolean. If true, the members’ order from the response will be used as AZ order on the UI.
  • 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.

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