[starting from version: 2.8]

A request for data.

Request

{
    "type": "select"
    "index": string,
    "query": {
        "aggs": {
            "values"[]: {
                "field": FieldObject,
                "func": string
            },
            "by": {
                "rows": FieldObject[],
                "cols": FieldObject[]
            }
        },
        "filter"[]: {
            "field": FieldObject,
            "include": string[] | number[],
            "exclude": string[] | number[],
            "query": {
                (condition): string | number | string[] | number[]
            },
            "value": {
                "field": FieldObject,
                "func": string
            }
        }
    },
    "page": number
}

Request has the following parameters:

• query – Object. A query object.
  • aggs – Object. Query aggregations.
    The part of query that specifies what data should be aggregated and how.
    • values – Array. Values to aggregate.
      Fields that have at least one supported aggregation defined in the schema can be selected for the query as values.
      • field – Field object.
      • func – String. Aggregation function. Supported values include: "sum", "count", "distinctcount", "average", "median", "product", "min", "max", "percent", "percentofcolumn", "percentofrow", "index", "stdevp", "stdevs", "none". For each field the list of supported aggregations is defined in the response to the fields request.
    • by – Object. Fields to aggregate by.
      • rows – Array of Field objects. Fields in rows.
      • cols – Array of Field objects. Fields in columns.
  • filter (optional) – Array. Query filters.
    The part of a query that specifies what filters should be applied.
    Each field with a filter is represented by a separate object.
    • field – Field object. The field to apply filter to.
    • include – Array of strings|Array of numbers. Field members to include. For string field type it is string[]. For number and date field types it is number[].
    • exclude – Array of strings|Array of numbers. Field members to exclude. For string field type it is string[]. For number and date field types it is number[].
    • query – Object. Conditional filter.
      • (condition) – String|Number|Array of strings| Array of numbers. Value for the condition, where condition to apply is (condition).
    • value – Object. Value to apply a conditional filter to.
      • field – Field object.
      • func – String. Aggregation function. Supported values include: "sum", "count", "distinctcount", "average", "median", "product", "min", "max", "percent", "percentofcolumn", "percentofrow", "index", "stdevp", "stdevs", "none". For each field the list of supported aggregations is defined in the response to the fields request.
  • page – Number. A page number. It can be used to load data by parts. If a response contains the pageTotal parameter, additional requests will be performed to load the remaining pages. Starts from 0.

Response

{
    "aggs"[]: {
        "values": {
            (uniqueName): {
                (func): number
            }
        },
        "keys": {
            (uniqueName): string
        }
    },
    "page": number,
    "pageTotal": number
} 

Response has the following parameters:

• aggs – Array. Aggregated data.
  • values – Object. Numeric values that are calculated for a specific tuple.
    • (uniqueName) – Object. Field’s unique name.
      • (func) – Number. Result of the calculation, where (func) if an aggregation function.
  • keys (optional) – Object. Field’s keys that describe a specific tuple. In case it is not defined, values are treated as totals.
    • (uniqueName) – String. Field’s member, where (uniqueName) is a field’s unique name.
• page (optional) – Number. Current page number. Starts from 0.
• pageTotal (optional) – Number. Total number of pages. It can be used to load members by parts.

Examples

1. Example with one value
   Request:

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

   Response:

   {
       "aggs": [{
           "values": {
               "price": {
                   "sum": 123
               }
           }
       }]
   }
   

2. Example with two values
   Request:

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

   Response:

   {
       "aggs": [{
           "values": {
               "price": {
                   "sum": 123
               },
               "quantity": {
                   "sum": 5
               }
           }
       }]
   }
   

3. Example with a field in rows
   Request:

   {
       "index": "data-set-123",
       "type": "select",
       "query": {
           "aggs": {
               "values": [{
                   "func": "sum", 
                   "field": {
                       "uniqueName": "price",
                       "type": "number"
                   }
               }],
               "by": {
                   "rows": [{
                       "uniqueName": "city",
                       "type": "string"
                   }]
               }
           }
       },
       "page": 0
   }
   

   Response:

   {
       "aggs": [{
           "values": {
               "price": {
                   "sum": 123
               }
           }
       }, {
           "keys": {
               "city": "Toronto"
           },
           "values": {
               "price": {
                   "sum": 100
               }
           }
       }, {
           "keys": {
               "city": "New York"
           },
           "values": {
               "price": {
                   "sum": 23
               }
           }
       }]
   }
   

4. Example with fields in rows and columns
   Request:

   {
       "index": "data-set-123",
       "type": "select",
       "query": {
           "aggs": {
               "values": [{
                   "func": "sum", 
                   "field": {
                       "uniqueName": "price",
                       "type": "number"
                   }
               }],
               "by": {
                   "rows": [{
                       "uniqueName": "city",
                       "type": "string"
                   }],
                   "cols": [{
                       "uniqueName": "color",
                       "type": "string"
                   }]
               }
           }
       },
       "page": 0
   }
   

   Response:

   {
       "aggs": [{
           "values": {
               "price": {
                   "sum": 48
               }
           }
       }, {
           "keys": {
               "city": "New York"
           },
           "values": {
               "price": {
                   "sum": 20
               }
           }
       }, {
           "keys": {
               "city": "Toronto"
           },
           "values": {
               "price": {
                   "sum": 28
               }
           }
       }, {
           "keys": {
               "color": "blue"
           },
           "values": {
               "price": {
                   "sum": 38
               }
           }
       }, {
           "keys": {
               "color": "red"
           },
           "values": {
               "price": {
                   "sum": 10
               }
           }
       }, {
           "keys": {
               "city": "New York",
               "color": "blue"
           },
           "values": {
               "price": {
                   "sum": 20
               }
           }
       }, {
           "keys": {
               "city": "Toronto",
               "color": "blue"
           },
           "values": {
               "price": {
                   "sum": 18
               }
           }
       }, {
           "keys": {
               "city": "Toronto",
               "color": "red"
           },
           "values": {
               "price": {
                   "sum": 10
               }
           }
       }]
   }
   

5. Example with exclude members filter
   Request:

   {
       "index": "data-set-123",
       "type": "select",
       "query": {
           "filter": [{
               "field": {
                   "uniqueName": "city",
                   "type": "string"
               },
               "exclude": ["New York", "Montreal"]
           }],
           "aggs": {
               "values": [{
                   "func": "sum",
                   "field": {
                       "uniqueName": "price",
                       "type": "number"
                   }
               }],
               "by": {
                   "rows": [{
                       "uniqueName": "city",
                       "type": "string"
                   }]
               }
           }
       }
   } 

   Response:
   Format is the same as above.
6. Example with include/exclude members filter on several fields
   Request:

   {
       "index": "data-set-123",
       "type": "select",
       "query": {
           "filter": [{
                   "field": {
                       "uniqueName": "color",
                       "type": "string"
                   },
                   "include": ["blue"]
               },
               {
                   "field": {
                       "uniqueName": "city",
                       "type": "string"
                   },
                   "exclude": ["New York", "Montreal"]
               }
           ],
           "aggs": {
               "values": [{
                   "func": "sum",
                   "field": {
                       "uniqueName": "price",
                       "type": "number"
                   }
               }],
               "by": {
                   "rows": [{
                       "uniqueName": "city",
                       "type": "string"
                   }]
               }
           }
       }
   }
   

   Response:
   Format is the same as above.
7. Example with a conditional filter on labels for string field
   Request:

   {
       "index": "data-set-123",
       "type": "select",
       "query": {
           "filter": [{
               "field": {
                   "uniqueName": "city",
                   "type": "string"
               },
               "query": {
                   "begin": "toro"
               }
           }],
           "aggs": {
               "values": [{
                   "func": "sum",
                   "field": {
                       "uniqueName": "price",
                       "type": "number"
                   }
               }],
               "by": {
                   "rows": [{
                       "uniqueName": "city",
                       "type": "string"
                   }]
               }
           }
       }
   }
   

   Response:
   Format is the same as above.
8. Example with a conditional filter on labels for number field
   Request:

   {
       "index": "data-set-123",
       "type": "select",
       "query": {
           "filter": [{
               "field": {
                   "uniqueName": "quantity",
                   "type": "number"
               },
               "query": {
                   "greater": 2
               }
           }],
           "aggs": {
               "values": [{
                   "func": "sum",
                   "field": {
                       "uniqueName": "price",
                       "type": "number"
                   }
               }],
               "by": {
                   "rows": [{
                       "uniqueName": "quantity",
                       "type": "number"
                   }]
               }
           }
       }
   }
   

   Response:
   Format is the same as above.
9. Example with a conditional filter on dates for date field
   Request:

   {
       "index": "data-set-123",
       "type": "select",
       "query": {
           "filter": [{
               "field": {
                   "field": "order_date",
                   "type": "date"
               },
               "query": {
                   between: [1564610400000, 1564696799999]
               }
           }],
           "aggs": {
               "values": [{
                   "func": "sum",
                   "field": {
                       "field": "price",
                       "type": "number"
                   }
               }],
               "by": {
                   "rows": [{
                       "field": "order_date",
                       "type": "date"
                   }]
               }
           }
       }
    }
   

   Response:
   Format is the same as above.
10.  Example with a conditional filter on values
    Request:

    {
        "index": "data-set-123",
        "type": "select",
        "query": {
            "filter": [{
                "field": {
                    "uniqueName": "city",
                    "type": "string"
                },
                "query": {
                    "top": 3
                },
                "value": {
                    "func": "sum",
                    "field": {
                        "uniqueName": "price",
                        "type": "number"
                    }
                }
            }],
            "aggs": {
                "values": [{
                    "func": "sum",
                    "field": {
                        "uniqueName": "price",
                        "type": "number"
                    }
                }],
                "by": {
                    "rows": [{
                        "uniqueName": "city",
                        "type": "string"
                    }]
                }
            }
        }
    }
    

    Response:
    Format is the same as above.

See also

/handshake request
/fields request
/members request
/select request for flat table
/select request for drill-through view
Field Object