Sign in
latestOpenAPI 3.0.12026-08-1163117239.4 KB

c5ac8232e334

ForecastModel

Checks model health for the given model id

The forecast model id must be a locked model of the type segmented or multivariate

post/model/modelhealth/{ForecastModelId}

Path parameters

ForecastModelIdstring uuid required

Request body

runModelHealthNowboolean

This field give the user the ability to ‘remotely press’ the ‘check model health now’ button in the app to get the latest model health results. The default operation for this input will be to NOT ‘check model health now’. When the default value of false (don’t run model health now) is replaced with a value of true (run model health now), the equivalent of depressing the green button in the app will be triggered.

Example request

{
  "runModelHealthNow": true,
  "referenceTable": [
    {
      "rule1_major_outlier": 0,
      "rule2_9pos_inarow": 0,
      "rule3_6_trend": 0,
      "rule4_14_up_and_down": 0,
      "rule5_2_out_of_3": 0,
      "rule6_4_out_of_5": 0,
      "rule7_15_stay_within_1std": 0,
      "rule8_8stay_out_1std": 0,
      "model_decay": 0,
      "dateString": "string"
    },
    {
      "rule1_major_outlier": 0,
      "rule2_9pos_inarow": 0,
      "rule3_6_trend": 0,
      "rule4_14_up_and_down": 0,
      "rule5_2_out_of_3": 0,
      "rule6_4_out_of_5": 0,
      "rule7_15_stay_within_1std": 0,
      "rule8_8stay_out_1std": 0,
      "model_decay": 0,
      "dateString": "string"
    },
    {
      "rule1_major_outlier": 0,
      "rule2_9pos_inarow": 0,
      "rule3_6_trend": 0,
      "rule4_14_up_and_down": 0,
      "rule5_2_out_of_3": 0,
      "rule6_4_out_of_5": 0,
      "rule7_15_stay_within_1std": 0,
      "rule8_8stay_out_1std": 0,
      "model_decay": 0,
      "dateString": "string"
    },
    {
      "rule1_major_outlier": 0,
      "rule2_9pos_inarow": 0,
      "rule3_6_trend": 0,
      "rule4_14_up_and_down": 0,
      "rule5_2_out_of_3": 0,
      "rule6_4_out_of_5": 0,
      "rule7_15_stay_within_1std": 0,
      "rule8_8stay_out_1std": 0,
      "model_decay": 0,
      "dateString": "string"
    },
    {
      "rule1_major_outlier": 0,
      "rule2_9pos_inarow": 0,
      "rule3_6_trend": 0,
      "rule4_14_up_and_down": 0,
      "rule5_2_out_of_3": 0,
      "rule6_4_out_of_5": 0,
      "rule7_15_stay_within_1std": 0,
      "rule8_8stay_out_1std": 0,
      "model_decay": 0,
      "dateString": "string"
    },
    {
      "rule1_major_outlier": 0,
      "rule2_9pos_inarow": 0,
      "rule3_6_trend": 0,
      "rule4_14_up_and_down": 0,
      "rule5_2_out_of_3": 0,
      "rule6_4_out_of_5": 0,
      "rule7_15_stay_within_1std": 0,
      "rule8_8stay_out_1std": 0,
      "model_decay": 0,
      "dateString": "string"
    },
    {
      "rule1_major_outlier": 0,
      "rule2_9pos_inarow": 0,
      "rule3_6_trend": 0,
      "rule4_14_up_and_down": 0,
      "rule5_2_out_of_3": 0,
      "rule6_4_out_of_5": 0,
      "rule7_15_stay_within_1std": 0,
      "rule8_8stay_out_1std": 0,
      "model_decay": 0,
      "dateString": "string"
    },
    {
      "rule1_major_outlier": 0,
      "rule2_9pos_inarow": 0,
      "rule3_6_trend": 0,
      "rule4_14_up_and_down": 0,
      "rule5_2_out_of_3": 0,
      "rule6_4_out_of_5": 0,
      "rule7_15_stay_within_1std": 0,
      "rule8_8stay_out_1std": 0,
      "model_decay": 0,
      "dateString": "string"
    },
    {
      "rule1_major_outlier": 0,
      "rule2_9pos_inarow": 0,
      "rule3_6_trend": 0,
      "rule4_14_up_and_down": 0,
      "rule5_2_out_of_3": 0,
      "rule6_4_out_of_5": 0,
      "rule7_15_stay_within_1std": 0,
      "rule8_8stay_out_1std": 0,
      "model_decay": 0,
      "dateString": "string"
    },
    {
      "rule1_major_outlier": 0,
      "rule2_9pos_inarow": 0,
      "rule3_6_trend": 0,
      "rule4_14_up_and_down": 0,
      "rule5_2_out_of_3": 0,
      "rule6_4_out_of_5": 0,
      "rule7_15_stay_within_1std": 0,
      "rule8_8stay_out_1std": 0,
      "model_decay": 0,
      "dateString": "string"
    },
    {
      "rule1_major_outlier": 0,
      "rule2_9pos_inarow": 0,
      "rule3_6_trend": 0,
      "rule4_14_up_and_down": 0,
      "rule5_2_out_of_3": 0,
      "rule6_4_out_of_5": 0,
      "rule7_15_stay_within_1std": 0,
      "rule8_8stay_out_1std": 0,
      "model_decay": 0,
      "dateString": "string"
    },
    {
      "rule1_major_outlier": 0,
      "rule2_9pos_inarow": 0,
      "rule3_6_trend": 0,
      "rule4_14_up_and_down": 0,
      "rule5_2_out_of_3": 0,
      "rule6_4_out_of_5": 0,
      "rule7_15_stay_within_1std": 0,
      "rule8_8stay_out_1std": 0,
      "model_decay": 0,
      "dateString": "string"
    },
    {
      "rule1_major_outlier": 0,
      "rule2_9pos_inarow": 0,
      "rule3_6_trend": 0,
      "rule4_14_up_and_down": 0,
      "rule5_2_out_of_3": 0,
      "rule6_4_out_of_5": 0,
      "rule7_15_stay_within_1std": 0,
      "rule8_8stay_out_1std": 0,
      "model_decay": 0,
      "dateString": "string"
    },
    {
      "rule1_major_outlier": 0,
      "rule2_9pos_inarow": 0,
      "rule3_6_trend": 0,
      "rule4_14_up_and_down": 0,
      "rule5_2_out_of_3": 0,
      "rule6_4_out_of_5": 0,
      "rule7_15_stay_within_1std": 0,
      "rule8_8stay_out_1std": 0,
      "model_decay": 0,
      "dateString": "string"
    },
    {
      "rule1_major_outlier": 0,
      "rule2_9pos_inarow": 0,
      "rule3_6_trend": 0,
      "rule4_14_up_and_down": 0,
      "rule5_2_out_of_3": 0,
      "rule6_4_out_of_5": 0,
      "rule7_15_stay_within_1std": 0,
      "rule8_8stay_out_1std": 0,
      "model_decay": 0,
      "dateString": "string"
    },
    {
      "rule1_major_outlier": 0,
      "rule2_9pos_inarow": 0,
      "rule3_6_trend": 0,
      "rule4_14_up_and_down": 0,
      "rule5_2_out_of_3": 0,
      "rule6_4_out_of_5": 0,
      "rule7_15_stay_within_1std": 0,
      "rule8_8stay_out_1std": 0,
      "model_decay": 0,
      "dateString": "string"
    }
  ]
}

Response

OK

modelHealthScoreAtPublishnumber double
projectIdstring uuid
modelIdstring uuid
modelTypestring nullable
instanceCodestring nullable
urlstring nullable