Written by

🚧 [Experimental] Get dataset data

Returns up to limit rows from the specified dataset. If sort is omitted, neither the row order nor the subset selected by limit is guaranteed and may change between requests. Every field used in sort must also be included in columns. An offset greater than zero requires a non-empty sort. For stable pagination, sorting should define a total order; add tie-breaking fields when sort values may repeat.

Request

POST

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

Headers

Name

Description

x-dl-api-version

Type: string

API version header.

Const: 2

Example: 2

Body

application/json

{
  "datasetId": "example",
  "workbookId": "example",
  "columns": [
    "example"
  ],
  "filters": [
    {
      "guid": "example",
      "operation": "in",
      "values": [
        "example"
      ]
    }
  ],
  "params": [
    {
      "guid": "example",
      "value": "example"
    }
  ],
  "sort": [
    {
      "guid": "example",
      "direction": "asc"
    }
  ],
  "limit": 1,
  "offset": 0
}

Name

Description

columns

Type: string[]

Dataset field GUIDs to return.

Min items: 1

Example

[
  "example"
]

datasetId

Type: string

Dataset ID.

Min length: 1

Example: example

filters

Type: object[]

guid

Type: string

Dataset field GUID.

Min length: 1

Example: example

operation

Type: string

Filter operation.

Enum: in, nin, isnull, isnotnull, between, eq, ne, gt, lt, gte, lte, istartswith, startswith, iendswith, endswith, icontains, contains, noticontains, notcontains, leneq, lenne, lengt, lengte, lenlt, lenlte

values

Type: array

Any of 3 types

Type: string

Example: example
Type: number
Type: boolean

Filter values; the required count depends on the operation.

Example

[
  "example"
]

Filters to apply.

Example

[
  {
    "guid": "example",
    "operation": "in",
    "values": [
      "example"
    ]
  }
]

limit

Type: integer

Maximum number of rows to return. Defaults to 100. Without sort, the selected rows and their order are not guaranteed.

Min value: 1

Max value: 100000

offset

Type: integer

Number of rows to skip. Values greater than zero require a non-empty sort.

Min value: 0

params

Type: object[]

guid

Type: string

Dataset parameter GUID.

Min length: 1

Example: example

value

Any of 3 types

Type: string

Example: example
Type: number
Type: boolean

Parameter value.

Example: example

Dataset parameter values.

Example

[
  {
    "guid": "example",
    "value": "example"
  }
]

sort

Type: object[]

direction

Type: string

Sort direction.

Enum: asc, desc

guid

Type: string

Dataset field GUID.

Min length: 1

Example: example

Sorting rules. Use a unique tie-breaking field to make pagination deterministic.

Example

[
  {
    "guid": "example",
    "direction": "asc"
  }
]

workbookId

Type: string | null

Workbook ID.

Min length: 1

Example: example

Responses

200 OK

Response

Body

application/json

{
  "schema": [
    {
      "name": "example",
      "guid": "example",
      "type": "date"
    }
  ],
  "rows": [
    [
      null
    ]
  ]
}

Name

Description

rows

Type: unknown[][]

Rows with values ordered according to schema.

Example

[
  [
    null
  ]
]

schema

Type: object[]

guid

Type: string

Dataset field GUID.

Min length: 1

Example: example

name

Type: string

Dataset field name.

Example: example

type

Type: string

Dataset field data type.

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

Returned columns in row value order.

Example

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

🚧 [Experimental] Get dataset data

RequestRequest

HeadersHeaders

BodyBody

ResponsesResponses

200 OK200 OK

BodyBody

Was the article helpful?

Request

Headers

Body

Responses

200 OK

Body