Skip to main content

DataSetGetQueryRequest

A data set GET query request.

Properties

Property Type Required Description
filters DataSetGetQueryFilters false

Query criteria relating to filter options.
geographicLevels DataSetGetQueryGeographicLevels false

Query criteria relating to geographic levels.
locations DataSetGetQueryLocations false

Query criteria relating to location options.
timePeriods DataSetGetQueryTimePeriods false

Query criteria relating to time periods.
indicators array (string) true

The IDs of indicators to return values for.

Validation constraints:

  • Minimum items: 1

Validation constraints for child items:

  • Maximum length: 40
  • Minimum length: 1
sorts array (string) false

The sorts to apply to the results. Sorts at the start of the list will be applied first.

By default, results are sorted by time period in descending order.
debug boolean false

Enable debug mode. Results will be formatted with human-readable labels to assist in identification.

This should not be enabled in a production environment.
page integer false

The page of results to fetch.

Defaults to: 1

Validation constraints:

  • Format: int32

  • Minimum: 1
pageSize integer false

The maximum number of results per page.

Defaults to: 1000

Validation constraints:

  • Format: int32

  • Minimum: 1

  • Maximum: 10000

Example schema

{
  "filters": {
    "eq": "pVAkV",
    "notEq": "wUzft",
    "in": [
      "n0WqP",
      "3dCWP"
    ],
    "notIn": [
      "RMxeh",
      "wUzft"
    ]
  },
  "geographicLevels": {
    "eq": "NAT",
    "notEq": "PROV",
    "in": [
      "NAT",
      "LA"
    ],
    "notIn": [
      "REG",
      "LAD"
    ]
  },
  "locations": {
    "eq": "NAT|id|3dCWP",
    "notEq": "REG|code|E12000003",
    "in": [
      "LA|code|E08000003",
      "LA|oldCode|373"
    ],
    "notIn": [
      "SCH|urn|123456",
      "SCH|laEstab|1234567"
    ]
  },
  "timePeriods": {
    "eq": "2024|CY",
    "notEq": "2024/2025|AY",
    "in": [
      "2022|CY",
      "2023|CY",
      "2024|CY"
    ],
    "notIn": [
      "2020|M1",
      "2020|M2",
      "2020|M3"
    ],
    "gt": "2017/2018|AY",
    "gte": "2017|CY",
    "lt": "2023/2024|AY",
    "lte": "2023|CY"
  },
  "indicators": [
    "string"
  ],
  "sorts": [
    "string"
  ],
  "debug": true,
  "page": 1,
  "pageSize": 1000
}