Skip to main content

DataSetQueryRequest

A data set query to match results against.

Properties

Property Type Required Description
criteria one of: false

The criteria to match.
indicators array (string) true

The IDs of indicators in the data set to return values for.

Validation constraints:

  • Minimum items: 1

Validation constraints for child items:

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

The sorts to sort the results by. 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

{
  "criteria": {
    "and": [
      {
        "filters": {
          "eq": "pVAkV"
        }
      },
      {
        "locations": {
          "eq": "LA|code|E08000019"
        }
      }
    ]
  },
  "indicators": [
    "C2ySJ",
    "q4X3J"
  ],
  "sorts": [
    {
      "field": "timePeriod",
      "direction": "Asc"
    }
  ],
  "debug": true,
  "page": 1,
  "pageSize": 1000
}