/select request for drill-through view

1./select request for drill-through view

[starting from version: 2.8]

A request for data.

Request

{
    "type": "select"
    "index": string,
    "query": {
        "fields": FieldObject[],
        "filter"[]: {
            "field": FieldObject,
            "include": string[] | number[],
            "exclude": string[] | number[],
            "query": {
                (condition): string | number | string[] | number[]
            },
            "value": {
                "field": FieldObject,
                "func": string
            }
        },
        "limit": number
    },
    "page": number
}

Request has the following parameters:

query – Object. A query object.
- fields – Array of Field objects. Array of fields (columns) to include in the response.
- filter (optional) – Array. Query filters.The part of query that specifies what filters should be applied. Each field with filter is represented by a separate object.
- limit – Number. The maximum number of records that should be included in the response. Сonfigurable on the client. Default is 1000.
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
    ],
    "page": number,
    "pageTotal": number
}

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.
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",
                "type": "string"
            },
            {
                "uniqueName": "city",
                "type": "string"
            },
            {
                "uniqueName": "price",
                "type": "number"
            },
            {
                "uniqueName": "quantity",
                "type": "number"
            }
        ],
        "filter": {
            "field": {
                "uniqueName": "country",
                "type": "string"
            }, 
            "include": ["Canada"]
        },
        "limit": 1000
    },
    "page": 0
}

Response:

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