Preview model mode

Preview model mode

Endpoint: /api/modelMode/predictedView

Request

Parameter Type Position Required Sample
Content-Type string Header Yes application/json
Accept string Header Yes application/json
Authorization string Header Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGci...
query json Body Yes JSON.stringify('[{ "postcode": "br11aa", "metrics": [ { "metric": "Air Quality", "dataset": "Air Quality", "year_from": "2017", "year_to": "2019" }, { "metric": "Air Quality", "dataset": "Harmonised Score", "year_from": "2017", "year_to": "2019" }, { "metric": "Sold Prices", "dataset": "Average Transfer Price for a Detached Property", "year_from": "2017", "year_to": "2019" } ] }]')

Success Response 

{
    "data": {
        "Air Quality": {
            "ranges": [
                [
                    2017,
                    9.67,
                    18.39
                ],
                [
                    2018,
                    8.93,
                    15.35
                ],
                [
                    2019,
                    8.58,
                    17.55
                ],
                [
                    2020,
                    16.56,
                    18.01
                ],
                [
                    2021,
                    18.52,
                    20.14
                ]
            ],
            "actuals": [
                [
                    2017,
                    12.41
                ],
                [
                    2018,
                    10.62
                ],
                [
                    2019,
                    10.23
                ],
                [
                    2020,
                    17.29
                ],
                [
                    2021,
                    19.33
                ]
            ]
        },
        "Harmonised Score": {
            "ranges": [
                [
                    2017,
                    1,
                    100
                ],
                [
                    2018,
                    1,
                    100
                ],
                [
                    2019,
                    1,
                    100
                ],
                [
                    2020,
                    1,
                    100
                ],
                [
                    2021,
                    1,
                    100
                ]
            ],
            "actuals": [
                [
                    2017,
                    68.91
                ],
                [
                    2018,
                    73.92
                ],
                [
                    2019,
                    81.85
                ],
                [
                    2020,
                    28.94
                ],
                [
                    2021,
                    28.92
                ]
            ]
        },
        "Average Transfer Price for a Detached Property": {
            "ranges": [
                [
                    2017,
                    329681,
                    24200000
                ],
                [
                    2018,
                    404920.3333,
                    18889976.44
                ],
                [
                    2019,
                    217202,
                    16475096
                ],
                [
                    2020,
                    188573.642,
                    1443806.235
                ],
                [
                    2021,
                    256861.5071,
                    1512094.1
                ]
            ],
            "actuals": [
                [
                    2017,
                    851813
                ],
                [
                    2018,
                    735703.7996
                ],
                [
                    2019,
                    758054.5052
                ],
                [
                    2020,
                    816189.9387
                ],
                [
                    2021,
                    884477.8038
                ]
            ]
        }
    }
}