/chart/data - VegasLounge API 对接文档

Takes a query context constructed in the client and returns payload data response for the given query.

Request

Body Params application/json

datasource

object (ChartDataDatasource)

optional

integer <int32>

required

Datasource id

type

enum<string>

optional

Datasource type

Allowed values:

druidtable

force

boolean

optional

Should the queries be forced to load from the source. Default: false

queries

array[object (ChartDataQueryObject) {27}]

optional

annotation_layers

array[object (AnnotationLayer) {16}] | null

optional

Annotation layers to apply to chart

applied_time_extras

object | null

optional

A mapping of temporal extras that have been applied to the query

Example:

{"__time_range":"1 year ago : now"}

columns

array[string] | null

optional

Columns which to select in the query.

datasource

null | allOf {1}

optional

druid_time_origin

string | null

optional

Starting point for time grain counting on legacy Druid datasources. Used to change e.g. Monday/Sunday first-day-of-week. This field is deprecated and should be passed to extras as druid_time_origin.

extras

null | allOf {1}

optional

Extra parameters to add to the query.

filters

array[object (ChartDataFilter) {3}] | null

optional

granularity

string | null

optional

Name of temporal column used for time filtering. For legacy Druid datasources this defines the time grain.

granularity_sqla

string | null

optional

Name of temporal column used for time filtering for SQL datasources. This field is deprecated, use granularity instead.

groupby

array[string] | null

optional

having

string | null

optional

HAVING clause to be added to aggregate queries using AND operator. This field is deprecated and should be passed to extras.

having_filters

array[object (ChartDataFilter) {3}] | null

optional

HAVING filters to be added to legacy Druid datasource queries. This field is deprecated and should be passed to extras as having_druid.

is_rowcount

boolean | null

optional

Should the rowcount of the actual query be returned

is_timeseries

boolean | null

optional

Is the query_object a timeseries.

metrics

array | null

optional

Aggregate expressions. Metrics can be passed as both references to datasource metrics (strings), or ad-hoc metricswhich are defined only within the query object. See ChartDataAdhocMetricSchema for the structure of ad-hoc metrics.

order_desc

boolean | null

optional

Reverse order. Default: false

orderby

array [array] | null

optional

Expects a list of lists where the first element is the column name which to sort by, and the second element is a boolean.

Example:

[["my_col_1",false],["my_col_2",true]]

post_processing

array [null] | null

optional

Post processing operations to be applied to the result set. Operations are applied to the result set in sequential order.

result_type

null

optional

row_limit

integer <int32> | null

optional

Maximum row count (0=disabled). Default: config["ROW_LIMIT"]

>= 0

row_offset

integer <int32> | null

optional

Number of rows to skip. Default: 0

>= 0

time_range

string | null

optional

A time rage, either expressed as a colon separated string since : until or human readable freeform. Valid formats for since and until are:

ISO 8601

X days/years/hours/day/year/weeks

X days/years/hours/day/year/weeks ago

X days/years/hours/day/year/weeks from now

Additionally, the following freeform can be used:

Last day

Last week

Last month

Last quarter

Last year

No filter

Last X seconds/minutes/hours/days/weeks/months/years

Next X seconds/minutes/hours/days/weeks/months/years

Example:

Last week

time_shift

string | null

optional

A human-readable date/time string. Please refer to parsdatetime documentation for details on valid values.

timeseries_limit

integer <int32> | null

optional

Maximum row count for timeseries queries. Default: 0

timeseries_limit_metric

null

optional

Metric used to limit timeseries queries by.

url_params

object | null

optional

Optional query parameters passed to a dashboard or Explore view

where

string | null

optional

WHERE clause to be added to queries using AND operator.This field is deprecated and should be passed to extras.

result_format

optional

result_type

optional

Example

{
    "datasource": {
        "id": 0,
        "type": "druid"
    },
    "force": true,
    "queries": [
        {
            "annotation_layers": [
                {
                    "annotationType": "FORMULA",
                    "color": "string",
                    "descriptionColumns": [
                        "string"
                    ],
                    "hideLine": true,
                    "intervalEndColumn": "string",
                    "name": "string",
                    "opacity": "",
                    "overrides": {
                        "property1": null,
                        "property2": null
                    },
                    "show": true,
                    "showMarkers": true,
                    "sourceType": "",
                    "style": "dashed",
                    "timeColumn": "string",
                    "titleColumn": "string",
                    "value": null,
                    "width": 0
                }
            ],
            "applied_time_extras": {
                "__time_range": "1 year ago : now"
            },
            "columns": [
                "string"
            ],
            "datasource": {
                "id": 0,
                "type": "druid"
            },
            "druid_time_origin": "string",
            "extras": {
                "druid_time_origin": "string",
                "having": "string",
                "having_druid": [
                    {
                        "col": "country",
                        "op": "==",
                        "val": [
                            "China",
                            "France",
                            "Japan"
                        ]
                    }
                ],
                "relative_end": "today",
                "relative_start": "today",
                "time_grain_sqla": "PT1S",
                "time_range_endpoints": [
                    "unknown"
                ],
                "where": "string"
            },
            "filters": [
                {
                    "col": "country",
                    "op": "==",
                    "val": [
                        "China",
                        "France",
                        "Japan"
                    ]
                }
            ],
            "granularity": "string",
            "granularity_sqla": "string",
            "groupby": [
                "string"
            ],
            "having": "string",
            "having_filters": [
                {
                    "col": "country",
                    "op": "==",
                    "val": [
                        "China",
                        "France",
                        "Japan"
                    ]
                }
            ],
            "is_rowcount": true,
            "is_timeseries": true,
            "metrics": [
                null
            ],
            "order_desc": true,
            "orderby": [
                [
                    "my_col_1",
                    false
                ],
                [
                    "my_col_2",
                    true
                ]
            ],
            "post_processing": [
                {
                    "operation": "aggregate",
                    "options": {
                        "aggregates": {
                            "age_mean": {
                                "column": "age",
                                "operator": "mean"
                            },
                            "age_q1": {
                                "column": "age",
                                "operator": "percentile",
                                "options": {
                                    "q": 0.25
                                }
                            }
                        },
                        "groupby": [
                            "country",
                            "gender"
                        ]
                    }
                }
            ],
            "result_type": null,
            "row_limit": 0,
            "row_offset": 0,
            "time_range": "Last week",
            "time_shift": "string",
            "timeseries_limit": 0,
            "timeseries_limit_metric": null,
            "url_params": {
                "property1": "string",
                "property2": "string"
            },
            "where": "string"
        }
    ],
    "result_format": null,
    "result_type": null
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/chart/data' \
--header 'Content-Type: application/json' \
--data-raw '{
    "datasource": {
        "id": 0,
        "type": "druid"
    },
    "force": true,
    "queries": [
        {
            "annotation_layers": [
                {
                    "annotationType": "FORMULA",
                    "color": "string",
                    "descriptionColumns": [
                        "string"
                    ],
                    "hideLine": true,
                    "intervalEndColumn": "string",
                    "name": "string",
                    "opacity": "",
                    "overrides": {
                        "property1": null,
                        "property2": null
                    },
                    "show": true,
                    "showMarkers": true,
                    "sourceType": "",
                    "style": "dashed",
                    "timeColumn": "string",
                    "titleColumn": "string",
                    "value": null,
                    "width": 0
                }
            ],
            "applied_time_extras": {
                "__time_range": "1 year ago : now"
            },
            "columns": [
                "string"
            ],
            "datasource": {
                "id": 0,
                "type": "druid"
            },
            "druid_time_origin": "string",
            "extras": {
                "druid_time_origin": "string",
                "having": "string",
                "having_druid": [
                    {
                        "col": "country",
                        "op": "==",
                        "val": [
                            "China",
                            "France",
                            "Japan"
                        ]
                    }
                ],
                "relative_end": "today",
                "relative_start": "today",
                "time_grain_sqla": "PT1S",
                "time_range_endpoints": [
                    "unknown"
                ],
                "where": "string"
            },
            "filters": [
                {
                    "col": "country",
                    "op": "==",
                    "val": [
                        "China",
                        "France",
                        "Japan"
                    ]
                }
            ],
            "granularity": "string",
            "granularity_sqla": "string",
            "groupby": [
                "string"
            ],
            "having": "string",
            "having_filters": [
                {
                    "col": "country",
                    "op": "==",
                    "val": [
                        "China",
                        "France",
                        "Japan"
                    ]
                }
            ],
            "is_rowcount": true,
            "is_timeseries": true,
            "metrics": [
                null
            ],
            "order_desc": true,
            "orderby": [
                [
                    "my_col_1",
                    false
                ],
                [
                    "my_col_2",
                    true
                ]
            ],
            "post_processing": [
                {
                    "operation": "aggregate",
                    "options": {
                        "aggregates": {
                            "age_mean": {
                                "column": "age",
                                "operator": "mean"
                            },
                            "age_q1": {
                                "column": "age",
                                "operator": "percentile",
                                "options": {
                                    "q": 0.25
                                }
                            }
                        },
                        "groupby": [
                            "country",
                            "gender"
                        ]
                    }
                }
            ],
            "result_type": null,
            "row_limit": 0,
            "row_offset": 0,
            "time_range": "Last week",
            "time_shift": "string",
            "timeseries_limit": 0,
            "timeseries_limit_metric": null,
            "url_params": {
                "property1": "string",
                "property2": "string"
            },
            "where": "string"
        }
    ],
    "result_format": null,
    "result_type": null
}'

Responses

🟢200OK

application/json

Query result

Body

result

array[object (ChartDataResponseResult) {13}]

optional

A list of results for each corresponding query in the request.

annotation_data

array [object {1}] | null

optional

All requested annotation data

applied_filters

array [object]

optional

A list with applied filters

cache_key

string | null

required

Unique cache key for query object

cache_timeout

integer <int32> | null

required

Cache timeout in following order: custom timeout, datasource timeout, default config timeout.

cached_dttm

string | null

required

Cache timestamp

data

array [object]

optional

A list with results

error

string | null

optional

Error

is_cached

boolean

required

Is the result cached

query

string

required

The executed query statement

rejected_filters

array [object]

optional

A list with rejected filters

rowcount

integer <int32>

optional

Amount of rows in result set

stacktrace

string | null

optional

status

enum<string>

optional

Status of the query

Allowed values:

stoppedfailedpendingrunningscheduledsuccesstimed_out

Example

{
    "result": [
        {
            "annotation_data": [
                {
                    "property1": "string",
                    "property2": "string"
                }
            ],
            "applied_filters": [
                {}
            ],
            "cache_key": "string",
            "cache_timeout": 0,
            "cached_dttm": "string",
            "data": [
                {}
            ],
            "error": "string",
            "is_cached": true,
            "query": "string",
            "rejected_filters": [
                {}
            ],
            "rowcount": 0,
            "stacktrace": "string",
            "status": "stopped"
        }
    ]
}

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error