Связаться с экспертомПопробовать бесплатно
Статья создана
Открыть в Markdown

🚧 [Experimental] Get chart data

Runs a saved Wizard, QL, or Editor chart with the supplied parameters and returns flat tables. Pivot tables are not supported. Editor charts require Editor.setRawData(). Large integers in Wizard results may lose precision. Limits across all results: 100000 rows, 100000 cells, 1000 tables and 100000 schema columns; up to 800 columns per table. Exceeding a limit returns HTTP 422; results are not truncated.

Request

POST

https://api.datalens.tech/rpc/getChartData

Headers

Name

Description

x-dl-api-version

Type: string

API version header.

Const: 3

Example: 3

Body

application/json
{
  "chartId": "example",
  "params": {}
}

Name

Description

chartId

Type: string

Saved chart ID.

Min length: 1

Example: example

params
Type: object

[additional]
Any of 2 types

  • Type: string

    Example: example

  • Type: string[]

    Example
    [
  "example"
]

Example: example

Chart parameters, including table pagination. Saved chart settings apply.

Example
{}

Responses

200 OK

Response

Body

application/json
{
  "chartType": "wizard",
  "results": [
    {
      "schema": [
        {}
      ],
      "rows": [
        [
          null
        ]
      ]
    }
  ]
}
One of 3 types

  • Type: GetWizardChartDataResult

    Example
    {
  "chartType": "wizard",
  "results": [
    {
      "schema": [
        {
          "name": "example",
          "guid": "example",
          "type": "date"
        }
      ],
      "rows": [
        [
          null
        ]
      ]
    }
  ]
}

  • Type: GetQLChartDataResult

    Example
    {
  "chartType": "ql",
  "results": [
    {
      "schema": [
        {
          "name": "example",
          "type": "example"
        }
      ],
      "rows": [
        [
          null
        ]
      ]
    }
  ]
}

  • Type: GetEditorChartDataResult

    Example
    {
  "chartType": "editor",
  "results": [
    {
      "schema": [
        {
          "name": "example"
        }
      ],
      "rows": [
        [
          null
        ]
      ]
    }
  ]
}

GetWizardChartDataResult

Name

Description

chartType

Type: string

Const: wizard

Example: example

results
Type: object[]

rows

Type: unknown[][]

Values ordered according to schema.

Example
[
  [
    null
  ]
]

schema
Type: object[]

name

Type: string

Example: example

type

Type: string

Enum: date, genericdatetime, datetimetz, integer, uinteger, string, float, boolean, geopoint, geopolygon, markup, heatmap, array_int, array_float, array_str, unsupported, hierarchy, tree_str, tree_int, tree_float

guid

Type: string

Field GUID, when provided by the source.

Example: example

Columns in row value order.

Example
[
  {
    "name": "example",
    "guid": "example",
    "type": "date"
  }
]

Tables in query and block order. Results with different schemas are returned separately.

Example
[
  {
    "schema": [
      {
        "name": "example",
        "guid": "example",
        "type": "date"
      }
    ],
    "rows": [
      [
        null
      ]
    ]
  }
]
Example
{
  "chartType": "wizard",
  "results": [
    {
      "schema": [
        {
          "name": "example",
          "guid": "example",
          "type": "date"
        }
      ],
      "rows": [
        [
          null
        ]
      ]
    }
  ]
}

GetQLChartDataResult

Name

Description

chartType

Type: string

Const: ql

Example: example

results
Type: object[]

rows

Type: unknown[][]

Values ordered according to schema.

Example
[
  [
    null
  ]
]

schema
Type: object[]

name

Type: string

Example: example

type

Type: string

QL value type, for example "number" or "string". Numeric values may be returned as strings.

Example: example

Columns in row value order.

Example
[
  {
    "name": "example",
    "type": "example"
  }
]

Tables in query and block order. Results with different schemas are returned separately.

Example
[
  {
    "schema": [
      {
        "name": "example",
        "type": "example"
      }
    ],
    "rows": [
      [
        null
      ]
    ]
  }
]
Example
{
  "chartType": "ql",
  "results": [
    {
      "schema": [
        {
          "name": "example",
          "type": "example"
        }
      ],
      "rows": [
        [
          null
        ]
      ]
    }
  ]
}

GetEditorChartDataResult

Name

Description

chartType

Type: string

Const: editor

Example: example

results
Type: object[]

rows

Type: unknown[][]

Values ordered according to schema.

Example
[
  [
    null
  ]
]

schema
Type: object[]

name

Type: string

Example: example

Columns in row value order.

Example
[
  {
    "name": "example"
  }
]

Tables in query and block order. Results with different schemas are returned separately.

Example
[
  {
    "schema": [
      {
        "name": "example"
      }
    ],
    "rows": [
      [
        null
      ]
    ]
  }
]
Example
{
  "chartType": "editor",
  "results": [
    {
      "schema": [
        {
          "name": "example"
        }
      ],
      "rows": [
        [
          null
        ]
      ]
    }
  ]
}
Предыдущая
🚧 [Experimental] Get dataset data
Следующая
Overview