[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:

• field – Field 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