{
  "request_id": "data_a8b4b29364094d07a4279cfd0c16ac9e",
  "release_id": "example-markets-release",
  "datasets": [
    {
      "dataset": "market_activity",
      "required": [
        "dataset",
        "area",
        "property_type"
      ],
      "optional": [
        "cursor",
        "from",
        "metrics",
        "page_size",
        "release_id",
        "to"
      ],
      "frequency": "monthly",
      "metrics": {
        "sales_count": {
          "unit": "sales"
        },
        "sales_value_gbp": {
          "unit": "GBP"
        },
        "sales_share_pct": {
          "unit": "percent"
        },
        "sales_value_share_pct": {
          "unit": "percent"
        },
        "sales_value_per_km2_gbp": {
          "unit": "GBP/km2"
        },
        "price_per_sqm_gbp": {
          "unit": "GBP/m2"
        }
      },
      "default_metrics": [
        "sales_count",
        "price_per_sqm_gbp",
        "sales_value_gbp",
        "sales_share_pct",
        "sales_value_per_km2_gbp"
      ],
      "selector_options": {
        "property_type": [
          "detached",
          "semi_detached",
          "terraced",
          "flat"
        ]
      },
      "requires_metric_selection": false,
      "history_capability": "retained_observations"
    },
    {
      "dataset": "price_bands",
      "required": [
        "dataset",
        "area",
        "price_band"
      ],
      "optional": [
        "cursor",
        "from",
        "metrics",
        "page_size",
        "release_id",
        "to"
      ],
      "frequency": "monthly",
      "metrics": {
        "sales_count": {
          "unit": "sales"
        },
        "sales_value_gbp": {
          "unit": "GBP"
        },
        "sales_share_pct": {
          "unit": "percent"
        },
        "house_share_pct": {
          "unit": "percent"
        },
        "flat_share_pct": {
          "unit": "percent"
        }
      },
      "default_metrics": [
        "sales_count",
        "sales_value_gbp",
        "sales_share_pct",
        "house_share_pct",
        "flat_share_pct"
      ],
      "selector_options": {
        "price_band": [
          1,
          2,
          3,
          4,
          5
        ]
      },
      "requires_metric_selection": false,
      "history_capability": "retained_observations"
    },
    {
      "dataset": "rental_market",
      "required": [
        "dataset",
        "area",
        "property_type",
        "bedroom_group"
      ],
      "optional": [
        "cursor",
        "from",
        "metrics",
        "page_size",
        "release_id",
        "to"
      ],
      "frequency": "monthly",
      "metrics": {
        "monthly_rent_gbp": {
          "unit": "GBP/month"
        },
        "property_value_gbp": {
          "unit": "GBP"
        },
        "gross_yield_pct": {
          "unit": "percent"
        }
      },
      "default_metrics": [
        "monthly_rent_gbp",
        "property_value_gbp",
        "gross_yield_pct"
      ],
      "selector_options": {
        "property_type": [
          "detached",
          "semi_detached",
          "terraced",
          "flat"
        ],
        "bedroom_group_by_property_type": {
          "flat": [
            "studio_1",
            "2",
            "3_plus"
          ],
          "detached": [
            "2",
            "3",
            "4_plus"
          ],
          "semi_detached": [
            "2",
            "3",
            "4_plus"
          ],
          "terraced": [
            "2",
            "3",
            "4_plus"
          ]
        }
      },
      "requires_metric_selection": false,
      "history_capability": "retained_observations"
    },
    {
      "dataset": "new_build_price_differential",
      "required": [
        "dataset",
        "area",
        "property_type"
      ],
      "optional": [
        "cursor",
        "from",
        "metrics",
        "page_size",
        "release_id",
        "to"
      ],
      "frequency": "monthly",
      "metrics": {
        "price_differential_pct": {
          "unit": "percent"
        },
        "lower_estimate_pct": {
          "unit": "percent"
        },
        "upper_estimate_pct": {
          "unit": "percent"
        }
      },
      "default_metrics": [
        "price_differential_pct",
        "lower_estimate_pct",
        "upper_estimate_pct"
      ],
      "selector_options": {
        "property_type": [
          "detached",
          "semi_detached",
          "terraced",
          "flat"
        ]
      },
      "requires_metric_selection": false,
      "history_capability": "retained_observations"
    },
    {
      "dataset": "new_build_deliveries",
      "required": [
        "dataset",
        "area",
        "property_type"
      ],
      "optional": [
        "cursor",
        "from",
        "metrics",
        "page_size",
        "release_id",
        "to"
      ],
      "frequency": "monthly",
      "metrics": {
        "deliveries_count": {
          "unit": "homes"
        }
      },
      "default_metrics": [
        "deliveries_count"
      ],
      "selector_options": {
        "property_type": [
          "detached",
          "semi_detached",
          "terraced",
          "flat",
          "combined"
        ]
      },
      "requires_metric_selection": false,
      "history_capability": "retained_observations"
    },
    {
      "dataset": "new_build_sales_share",
      "required": [
        "dataset",
        "area",
        "property_type"
      ],
      "optional": [
        "cursor",
        "from",
        "metrics",
        "page_size",
        "release_id",
        "to"
      ],
      "frequency": "monthly",
      "metrics": {
        "new_build_sales_count": {
          "unit": "sales"
        },
        "residential_sales_count": {
          "unit": "sales"
        },
        "new_build_sales_share_pct": {
          "unit": "percent"
        }
      },
      "default_metrics": [
        "new_build_sales_count",
        "residential_sales_count",
        "new_build_sales_share_pct"
      ],
      "selector_options": {
        "property_type": [
          "detached",
          "semi_detached",
          "terraced",
          "flat",
          "combined"
        ]
      },
      "requires_metric_selection": false,
      "history_capability": "retained_observations"
    },
    {
      "dataset": "development_deliveries",
      "required": [
        "dataset",
        "area",
        "property_type",
        "development_size"
      ],
      "optional": [
        "cursor",
        "from",
        "metrics",
        "page_size",
        "release_id",
        "to"
      ],
      "frequency": "monthly",
      "metrics": {
        "deliveries_count": {
          "unit": "homes"
        },
        "share_of_deliveries_pct": {
          "unit": "percent"
        },
        "share_of_classified_deliveries_pct": {
          "unit": "percent"
        }
      },
      "default_metrics": [
        "deliveries_count",
        "share_of_deliveries_pct",
        "share_of_classified_deliveries_pct"
      ],
      "selector_options": {
        "property_type": [
          "detached",
          "semi_detached",
          "terraced",
          "flat"
        ],
        "development_size": [
          "single_home",
          "small",
          "medium",
          "large"
        ]
      },
      "requires_metric_selection": false,
      "history_capability": "retained_observations"
    }
  ]
}
