Skip to main content

DataSetQueryResultViewModel

A result from a data set query containing its values and any facets relevant to it.

Properties

Property Type Required Description
timePeriod TimePeriodViewModel true

The time period relevant to this result’s data.

geographicLevel GeographicLevelCode true

The geographic level relevant to this result’s data.

locations dictionary (string) true

The locations relevant to this result’s data.

This is a dictionary where the key is the location’s geographic level and the value is the location’s ID.

filters dictionary (string) true

The filters associated with this result.

This is a dictionary where the key is the filter ID and the value is the specific filter option ID.

values dictionary (string) true

The data values for the result’s indicators.

This is a dictionary where the key is the indicator ID and the value is the data value.

Example schema

{
  "timePeriod": {
    "code": "AYQ1",
    "period": "2020/2021"
  },
  "geographicLevel": "NAT",
  "locations": {
    "<*>": "string"
  },
  "filters": {
    "<*>": "string"
  },
  "values": {
    "<*>": "string"
  }
}