Predict model mode

Predict model mode

Endpoint: /api/modelMode/predict

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", "year_to": "2019", "active_dataset": { "metric": "Air Quality", "dataset": "Air Quality", "slider_value": 0.4 }, "variable_datasets": [ { "metric": "Air Quality", "dataset": "Harmonised Score" }, { "metric": "Sold Prices", "dataset": "Average Transfer Price for a Detached Property" } ] }]')

Success Response 

{
    "data": {
        "Harmonised Score": {
            "ranges": [
                [
                    2020,
                    0.7,
                    70
                ],
                [
                    2021,
                    0.7,
                    70
                ]
            ],
            "actuals": [
                [
                    2020,
                    20.258000000000003
                ],
                [
                    2021,
                    20.244
                ]
            ]
        },
        "Average Transfer Price for a Detached Property": {
            "ranges": [
                [
                    2020,
                    207431.0062,
                    1588186.8585
                ],
                [
                    2021,
                    282547.65781,
                    1663303.51
                ]
            ],
            "actuals": [
                [
                    2020,
                    897808.9325700001
                ],
                [
                    2021,
                    972925.58418
                ]
            ]
        }
    }
}