Skip to content

Click in-app to access the full platform documentation for your version of DataRobot.

Insights

This page outlines the operations, endpoints, parameters, and example requests and responses for the Insights.

GET /api/v2/multilabelInsights/{multilabelInsightsKey}/histogram/

Retrieve multicategorical feature histogram.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/multilabelInsights/{multilabelInsightsKey}/histogram/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
multilabelInsightsKey path string true Key for multilabel insights, unique per project, feature, and EDA stage. The most recent key can be retrieved via GET /api/v2/projects/{projectId}/features/ or [GET /api/v2/projects/{projectId}/features/{featurename:featureName}/][get-apiv2projectsprojectidfeaturesfeaturenamefeaturename]

Example responses

200 Response

{
  "featureName": "string",
  "histogram": [
    {
      "label": "string",
      "plot": [
        {
          "labelRelevance": 1,
          "rowCount": 0,
          "rowPct": 100
        },
        {
          "labelRelevance": 1,
          "rowCount": 0,
          "rowPct": 100
        }
      ]
    }
  ],
  "projectId": "string"
}

Responses

Status Meaning Description Schema
200 OK Multicategorical feature histogram. MulticategoricalHistogram

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/

Get all label lists.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
multilabelInsightsKey path string true Key for multilabel insights, unique per project, feature, and EDA stage. The most recent key can be retrieved via GET /api/v2/projects/{projectId}/features/ or [GET /api/v2/projects/{projectId}/features/{featurename:featureName}/][get-apiv2projectsprojectidfeaturesfeaturenamefeaturename]

Example responses

200 Response

{
  "data": [
    {
      "columnLabels": [
        "string"
      ],
      "id": "string",
      "name": "string",
      "rowLabels": [
        "string"
      ]
    }
  ],
  "featureName": "string",
  "multilabelInsightsKey": "string",
  "projectId": "string"
}

Responses

Status Meaning Description Schema
200 OK All label lists PairwiseManualSelectionsRetrieveResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/

Save a list of manually selected labels for Feature Statistics matrix.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "columnLabels": [
    "string"
  ],
  "featureName": "string",
  "multilabelInsightsKey": "string",
  "name": "string",
  "projectId": "string",
  "rowLabels": [
    "string"
  ]
}

Parameters

Name In Type Required Description
multilabelInsightsKey path string true Key for multilabel insights, unique per project, feature, and EDA stage. The most recent key can be retrieved via GET /api/v2/projects/{projectId}/features/ or [GET /api/v2/projects/{projectId}/features/{featurename:featureName}/][get-apiv2projectsprojectidfeaturesfeaturenamefeaturename]
body body PairwiseManualSelectionCreatePayload false none

Example responses

200 Response

{
  "id": "string"
}

Responses

Status Meaning Description Schema
200 OK Whether manually selected labels were saved successfully. PairwiseManualSelectionCreateResponse
422 Unprocessable Entity The manual selection name is already taken or another exception occurred. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/{manualSelectionListId}/

Delete label list.

Code samples

# You can also use wget
curl -X DELETE http://10.97.111.38/api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/{manualSelectionListId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
multilabelInsightsKey path string true Key for multilabel insights, unique per project, feature, and EDA stage. The most recent key can be retrieved via GET /api/v2/projects/{projectId}/features/ or [GET /api/v2/projects/{projectId}/features/{featurename:featureName}/][get-apiv2projectsprojectidfeaturesfeaturenamefeaturename]
manualSelectionListId path string true ID of the label set.

Example responses

200 Response

{
  "manualSelectionId": "string"
}

Responses

Status Meaning Description Schema
200 OK ID of the deleted label list. PairwiseManualSelectionResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/{manualSelectionListId}/

Update label list's name.

Code samples

# You can also use wget
curl -X PATCH http://10.97.111.38/api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/{manualSelectionListId}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "name": "string"
}

Parameters

Name In Type Required Description
multilabelInsightsKey path string true Key for multilabel insights, unique per project, feature, and EDA stage. The most recent key can be retrieved via GET /api/v2/projects/{projectId}/features/ or [GET /api/v2/projects/{projectId}/features/{featurename:featureName}/][get-apiv2projectsprojectidfeaturesfeaturenamefeaturename]
manualSelectionListId path string true ID of the label set.
body body PairwiseManualSelectionUpdateRequest false none

Example responses

200 Response

{
  "manualSelectionId": "string"
}

Responses

Status Meaning Description Schema
200 OK ID of the updated label list. PairwiseManualSelectionResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseStatistics/

Retrieve multilabel specific pairwise label statistics for the given multilabel insights key: correlation, joint probability and conditional probability.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseStatistics/?statisticType=correlation \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
statisticType query string true Type of pairwise statistic.
multilabelInsightsKey path string true Key for multilabel insights, unique per project, feature, and EDA stage. The most recent key can be retrieved via GET /api/v2/projects/{projectId}/features/ or [GET /api/v2/projects/{projectId}/features/{featurename:featureName}/][get-apiv2projectsprojectidfeaturesfeaturenamefeaturename]

Enumerated Values

Parameter Value
statisticType correlation
statisticType jointProbability
statisticType conditionalProbability

Example responses

200 Response

{
  "data": [
    {
      "labelConfiguration": [
        {
          "label": "string",
          "relevance": 1
        },
        {
          "label": "string",
          "relevance": 1
        }
      ],
      "statisticValue": 0
    }
  ],
  "featureName": "string",
  "projectId": "stringstringstringstring",
  "statisticType": "correlation"
}

Responses

Status Meaning Description Schema
200 OK Pairwise label statistics. PairwiseStatisticsResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/anomalyAssessmentRecords/

Retrieve anomaly assessment records.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/anomalyAssessmentRecords/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
modelId query string false The model ID to filter records by.
backtest query any false The backtest to filter records by.
source query string false The source of the data to filter records by.
seriesId query string false Can be specified for multiseries projects. The series id to filter records by.
projectId path string true The project ID

Enumerated Values

Parameter Value
source training
source validation

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "backtest": 19,
      "deleteLocation": "http://example.com",
      "endDate": "2019-08-24T14:15:22Z",
      "latestExplanationsLocation": "http://example.com",
      "modelId": "string",
      "predictionThreshold": 0,
      "previewLocation": "http://example.com",
      "projectId": "string",
      "recordId": "string",
      "seriesId": "string",
      "source": "training",
      "startDate": "2019-08-24T14:15:22Z",
      "status": "noData",
      "statusDetails": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Responses

Status Meaning Description Schema
200 OK Retrieve anomaly assessment records. AnomalyAssessmentRecordsResponse
404 Not Found No data found None
422 Unprocessable Entity Input parameters are invalid None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/projects/{projectId}/anomalyAssessmentRecords/{recordId}/

Delete the anomaly assessment record.

Code samples

# You can also use wget
curl -X DELETE http://10.97.111.38/api/v2/projects/{projectId}/anomalyAssessmentRecords/{recordId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
recordId path string true The anomaly assessment record ID

Responses

Status Meaning Description Schema
204 No Content Anomaly assessment record deleted. None
404 Not Found Data was not found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/anomalyAssessmentRecords/{recordId}/explanations/

Retrieve anomaly assessment record. Two out of three parameters: startDate, endDate or pointsCount must be specified.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/anomalyAssessmentRecords/{recordId}/explanations/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
startDate query string(date-time) false The start of the date range to return. Date should be in UTC format. For example: 2019-08-01T00:00:00.000000Z.
endDate query string(date-time) false The end of the date range to return, inclusive. Date should be in UTC format. For example: 2020-01-01T00:00:00.000000Z.
pointsCount query integer false Count of points to return.
projectId path string true The project ID
recordId path string true The anomaly assessment record ID

Example responses

200 Response

{
  "backtest": 19,
  "count": 0,
  "data": [
    {
      "prediction": 0,
      "shapExplanation": [
        {
          "feature": "string",
          "featureValue": "string",
          "strength": 0
        }
      ],
      "timestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "endDate": "2019-08-24T14:15:22Z",
  "modelId": "string",
  "projectId": "string",
  "recordId": "string",
  "seriesId": "string",
  "shapBaseValue": 0,
  "source": "training",
  "startDate": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK Anomaly assessment record. AnomalyAssessmentExplanationsResponse
404 Not Found Data was not found. None
422 Unprocessable Entity Insight is not available. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/anomalyAssessmentRecords/{recordId}/predictionsPreview/

Retrieve predictions preview for the anomaly assessment record.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/anomalyAssessmentRecords/{recordId}/predictionsPreview/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
recordId path string true The anomaly assessment record ID

Example responses

200 Response

{
  "backtest": 19,
  "endDate": "2019-08-24T14:15:22Z",
  "modelId": "string",
  "previewBins": [
    {
      "avgPredicted": 0,
      "endDate": "2019-08-24T14:15:22Z",
      "frequency": 0,
      "maxPredicted": 0,
      "startDate": "2019-08-24T14:15:22Z"
    }
  ],
  "projectId": "string",
  "recordId": "string",
  "seriesId": "string",
  "source": "training",
  "startDate": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK Predictions preview for the anomaly assessment record. AnomalyAssessmentPreviewResponse
404 Not Found Record not found. None
422 Unprocessable Entity Predictions preview is not available. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/biasVsAccuracyInsights/

Retrieve a list of Bias vs Accuracy insights for the model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/biasVsAccuracyInsights/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
accuracyMetric query string false The metric to return model accuracy scores. Defaults to the optimization metric configured in project options.
protectedFeature query any false Name of the protected feature.
fairnessMetric query any false The fairness metric used to calculate the fairness scores.
projectId path string true The project ID

Enumerated Values

Parameter Value
accuracyMetric AUC
accuracyMetric Weighted AUC
accuracyMetric Area Under PR Curve
accuracyMetric Weighted Area Under PR Curve
accuracyMetric Kolmogorov-Smirnov
accuracyMetric Weighted Kolmogorov-Smirnov
accuracyMetric Ians Metric
accuracyMetric FVE Binomial
accuracyMetric Weighted FVE Binomial
accuracyMetric Gini
accuracyMetric Weighted Gini
accuracyMetric Gini Norm
accuracyMetric Weighted Gini Norm
accuracyMetric LogLoss
accuracyMetric Weighted LogLoss
accuracyMetric LogLossSig
accuracyMetric Weighted LogLossSig
accuracyMetric Max MCC
accuracyMetric Weighted Max MCC
accuracyMetric Rate@Top5%
accuracyMetric Weighted Rate@Top5%
accuracyMetric Rate@Top10%
accuracyMetric Weighted Rate@Top10%
accuracyMetric Rate@TopTenth%
accuracyMetric RMSE
accuracyMetric Weighted RMSE

Example responses

200 Response

{
  "data": [
    {
      "accuracyMetric": "AUC",
      "fairnessMetric": "proportionalParity",
      "fairnessThreshold": 0.8,
      "models": [
        {
          "accuracyValue": 0,
          "bp": 0,
          "dsName": "string",
          "fairnessValue": 1,
          "modelId": "string",
          "modelNumber": 0,
          "modelType": "string",
          "prime": true,
          "samplepct": 100
        }
      ],
      "protectedFeature": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Returns Bias vs Accuracy results. BiasVsAccuracyInsightRetrieve

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/accuracyOverTimePlots/

Retrieve the data for the Accuracy over Time plots.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/accuracyOverTimePlots/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
seriesId query string false The name of the series to retrieve. Only available for time series multiseries projects. If not provided an average plot for the first 1000 series will be retrieved.
backtest query any false Retrieve plots for a specific backtest (use the backtest index starting from zero) or holdout. If not specified the first backtest (backtest index 0) will be used.
source query string false The source of the data for the backtest/holdout.
forecastDistance query integer false Forecast distance to retrieve the data for. If not specified, the first forecast distance for this project will be used. Forecast distance specifies the number of time steps between the predicted point and the origin point. Only available for time series supervised projects.
resolution query string false Specifying at which resolution the data should be binned. If not specified, optimal resolution will be used to build chart data with number of bins <= maxBinSize
maxBinSize query integer false Specifies the maximum number of bins for the retrieval.
startDate query string(date-time) false The start of the date range to return. If not specified, start date for requested plots will be used.
endDate query string(date-time) false The end of the date range to return. If not specified, end date for requested plots will be used.
projectId path string true The project ID
modelId path string true The model ID

Enumerated Values

Parameter Value
source training
source validation
resolution milliseconds
resolution seconds
resolution minutes
resolution hours
resolution days
resolution weeks
resolution months
resolution quarters
resolution years

Example responses

200 Response

{
  "bins": [
    {
      "actual": 0,
      "endDate": "2019-08-24T14:15:22Z",
      "frequency": 0,
      "predicted": 0,
      "startDate": "2019-08-24T14:15:22Z"
    }
  ],
  "calendarEvents": [
    {
      "date": "2019-08-24T14:15:22Z",
      "name": "string",
      "seriesId": "string"
    }
  ],
  "endDate": "2019-08-24T14:15:22Z",
  "resolution": "milliseconds",
  "startDate": "2019-08-24T14:15:22Z",
  "statistics": {
    "durbinWatson": 4
  }
}

Responses

Status Meaning Description Schema
200 OK Accuracy over Time plots data AccuracyOverTimePlotsDataResponse
404 Not Found Accuracy over Time plots data was not found None
422 Unprocessable Entity Invalid parameters were submitted None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/accuracyOverTimePlots/metadata/

Retrieve the metadata for the Accuracy over Time plots.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/accuracyOverTimePlots/metadata/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
forecastDistance query integer false Forecast distance to retrieve the data for. If not specified, the first forecast distance for this project will be used. Forecast distance specifies the number of time steps between the predicted point and the origin point. Only available for time series supervised projects.
seriesId query string false The name of the series to retrieve. Only available for time series multiseries projects. If not provided a metadata of average plot for the first 1000 series will be retrieved.
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "backtestMetadata": [
    {
      "training": {
        "endDate": "2019-08-24T14:15:22Z",
        "startDate": "2019-08-24T14:15:22Z"
      },
      "validation": {
        "endDate": "2019-08-24T14:15:22Z",
        "startDate": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "backtestStatuses": [
    {
      "training": "errored",
      "validation": "errored"
    }
  ],
  "estimatedSeriesLimit": 1,
  "forecastDistance": 1000,
  "holdoutMetadata": {
    "training": {
      "endDate": "2019-08-24T14:15:22Z",
      "startDate": "2019-08-24T14:15:22Z"
    },
    "validation": {
      "endDate": "2019-08-24T14:15:22Z",
      "startDate": "2019-08-24T14:15:22Z"
    }
  },
  "holdoutStatuses": {
    "training": "errored",
    "validation": "errored"
  },
  "resolutions": [
    "milliseconds"
  ]
}

Responses

Status Meaning Description Schema
200 OK Accuracy over Time plots metadata AccuracyOverTimePlotsMetadataResponse
404 Not Found Accuracy over Time plots metadata was not found None
422 Unprocessable Entity Invalid parameters were submitted None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/accuracyOverTimePlots/preview/

Retrieve the preview for the Accuracy over Time plots.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/accuracyOverTimePlots/preview/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
seriesId query string false The name of the series to retrieve. Only available for time series multiseries projects. If not provided an average plot for the first 1000 series will be retrieved.
backtest query any false Retrieve plots for a specific backtest (use the backtest index starting from zero) or holdout. If not specified the first backtest (backtest index 0) will be used.
source query string false The source of the data for the backtest/holdout.
forecastDistance query integer false Forecast distance to retrieve the data for. If not specified, the first forecast distance for this project will be used. Forecast distance specifies the number of time steps between the predicted point and the origin point. Only available for time series supervised projects.
projectId path string true The project ID
modelId path string true The model ID

Enumerated Values

Parameter Value
source training
source validation

Example responses

200 Response

{
  "bins": [
    {
      "actual": 0,
      "endDate": "2019-08-24T14:15:22Z",
      "predicted": 0,
      "startDate": "2019-08-24T14:15:22Z"
    }
  ],
  "endDate": "2019-08-24T14:15:22Z",
  "startDate": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK Accuracy over Time plots preview DatetimeTrendPlotsPreviewResponse
404 Not Found Accuracy over Time plots preview was not found None
422 Unprocessable Entity Invalid parameters were submitted None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/anomalyOverTimePlots/

Retrieve the data for the Anomaly over Time plots.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/anomalyOverTimePlots/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
seriesId query string false The name of the series to retrieve. Only available for time series multiseries projects. If not provided an average plot for the first 1000 series will be retrieved.
backtest query any false Retrieve plots for a specific backtest (use the backtest index starting from zero) or holdout. If not specified the first backtest (backtest index 0) will be used.
source query string false The source of the data for the backtest/holdout.
resolution query string false Specifying at which resolution the data should be binned. If not specified, optimal resolution will be used to build chart data with number of bins <= maxBinSize
maxBinSize query integer false Specifies the maximum number of bins for the retrieval.
startDate query string(date-time) false The start of the date range to return. If not specified, start date for requested plots will be used.
endDate query string(date-time) false The end of the date range to return. If not specified, end date for requested plots will be used.
projectId path string true The project ID
modelId path string true The model ID

Enumerated Values

Parameter Value
source training
source validation
resolution milliseconds
resolution seconds
resolution minutes
resolution hours
resolution days
resolution weeks
resolution months
resolution quarters
resolution years

Example responses

200 Response

{
  "bins": [
    {
      "endDate": "2019-08-24T14:15:22Z",
      "frequency": 0,
      "predicted": 0,
      "startDate": "2019-08-24T14:15:22Z"
    }
  ],
  "calendarEvents": [
    {
      "date": "2019-08-24T14:15:22Z",
      "name": "string",
      "seriesId": "string"
    }
  ],
  "endDate": "2019-08-24T14:15:22Z",
  "resolution": "milliseconds",
  "startDate": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK Anomaly over Time plots data AnomalyOverTimePlotsDataResponse
404 Not Found Anomaly over Time plots data was not found None
422 Unprocessable Entity Invalid parameters were submitted None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/anomalyOverTimePlots/metadata/

Retrieve the metadata for the Anomaly over Time plots.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/anomalyOverTimePlots/metadata/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
seriesId query string false The name of the series to retrieve. Only available for time series multiseries projects. If not provided a metadata of average plot for the first 1000 series will be retrieved.
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "backtestMetadata": [
    {
      "training": {
        "endDate": "2019-08-24T14:15:22Z",
        "startDate": "2019-08-24T14:15:22Z"
      },
      "validation": {
        "endDate": "2019-08-24T14:15:22Z",
        "startDate": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "backtestStatuses": [
    {
      "training": "errored",
      "validation": "errored"
    }
  ],
  "estimatedSeriesLimit": 1,
  "holdoutMetadata": {
    "training": {
      "endDate": "2019-08-24T14:15:22Z",
      "startDate": "2019-08-24T14:15:22Z"
    },
    "validation": {
      "endDate": "2019-08-24T14:15:22Z",
      "startDate": "2019-08-24T14:15:22Z"
    }
  },
  "holdoutStatuses": {
    "training": "errored",
    "validation": "errored"
  },
  "resolutions": [
    "milliseconds"
  ]
}

Responses

Status Meaning Description Schema
200 OK Anomaly over Time plots metadata AnomalyOverTimePlotsMetadataResponse
404 Not Found Anomaly over Time plots metadata was not found None
422 Unprocessable Entity Invalid parameters were submitted None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/anomalyOverTimePlots/preview/

Retrieve the preview for the Anomaly over Time plots.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/anomalyOverTimePlots/preview/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
seriesId query string false The name of the series to retrieve. Only available for time series multiseries projects. If not provided an average plot for the first 1000 series will be retrieved.
backtest query any false Retrieve plots for a specific backtest (use the backtest index starting from zero) or holdout. If not specified the first backtest (backtest index 0) will be used.
source query string false The source of the data for the backtest/holdout.
predictionThreshold query number false Only bins with predictions exceeding this threshold will be returned in the response.
projectId path string true The project ID
modelId path string true The model ID

Enumerated Values

Parameter Value
source training
source validation

Example responses

200 Response

{
  "bins": [
    {
      "endDate": "2019-08-24T14:15:22Z",
      "startDate": "2019-08-24T14:15:22Z"
    }
  ],
  "endDate": "2019-08-24T14:15:22Z",
  "predictionThreshold": 0,
  "startDate": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK Anomaly over Time plots preview AnomalyOverTimePlotsPreviewResponse
404 Not Found Anomaly over Time plots preview was not found None
422 Unprocessable Entity Invalid parameters were submitted None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/backtestStabilityPlot/

Retrieve a plot displaying the stability of the datetime model across different backtests.

All durations and datetimes should be specified in accordance with the :ref:timestamp and duration formatting rules<time_format>.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/backtestStabilityPlot/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
metricName query string false The name of the metric to retrieve the scores for. If omitted, the default project metric will be used
forecastDistance query integer false The forecast distance to retrieve the plot for. If not specified, the scores for each partition are aggregated across all forecast distances. This parameter is only available for time series models.
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "backtestPlotData": [
    {
      "backtestIndex": 0,
      "partition": "string",
      "score": 0,
      "scoringEndDate": "2019-08-24T14:15:22Z",
      "scoringStartDate": "2019-08-24T14:15:22Z"
    }
  ],
  "endDate": "2019-08-24T14:15:22Z",
  "metricName": "string",
  "startDate": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK Backtest stability plot data for datetime partitioned model. BacktestStabilityPlotResponse
422 Unprocessable Entity Backtest stability plot data not available. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/datasetAccuracyOverTimePlots/{datasetId}/

Retrieve the Accuracy Over Time (AOT) chart data for an external dataset for a project. Datetimes are specified in accordance with :ref:timestamp and duration formatting rules <time_format>.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/datasetAccuracyOverTimePlots/{datasetId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
maxBinSize query integer false The limit of returned bins.
startDate query string(date-time) false The start of the date range to return (UTC string), for example: '2010-05-13T00:00:00.000000Z'. If not specified, the start date for this model and source of the data will be used instead.
endDate query string(date-time) false The end of the date range to return (UTC string), for example: '2010-05-13T00:00:00.000000Z'. If not specified, the end date for this model and source of the data will be used instead.
resolution query string false Specifies at which resolution the data should be binned. If not specified, optimal resolution will be used to build chart data such that bins <= maxBinSize.
projectId path string true The project id which was used to compute the AOT chart.
modelId path string true The model id which was used to compute the AOT chart.
datasetId path string true The dataset id which was used to compute the AOT chart.

Enumerated Values

Parameter Value
resolution microseconds
resolution milliseconds
resolution seconds
resolution minutes
resolution hours
resolution days
resolution weeks
resolution months
resolution quarters
resolution years

Example responses

200 Response

{
  "bins": [
    {
      "actual": 0,
      "endDate": "2019-08-24T14:15:22Z",
      "frequency": 0,
      "predicted": 0,
      "startDate": "2019-08-24T14:15:22Z"
    }
  ],
  "datasetId": "string",
  "endDate": "2019-08-24T14:15:22Z",
  "modelId": "string",
  "projectId": "string",
  "resolution": "microseconds",
  "startDate": "2019-08-24T14:15:22Z",
  "statistics": {
    "durbinWatson": 0
  }
}

Responses

Status Meaning Description Schema
200 OK Accuracy Over Time (AOT) chart data for an external dataset for a project. AOTChartRetrieveResponse
404 Not Found No insights found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/datasetAccuracyOverTimePlots/{datasetId}/metadata/

Retrieve the metadata of the Accuracy Over Time (AOT) chart for an external dataset. Datetimes are specified in accordance with :ref:timestamp and duration formatting rules <time_format>.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/datasetAccuracyOverTimePlots/{datasetId}/metadata/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project id which was used to compute the AOT chart.
modelId path string true The model id which was used to compute the AOT chart.
datasetId path string true The dataset id which was used to compute the AOT chart.

Example responses

200 Response

{
  "datasetId": "string",
  "datasetMetadata": {
    "endDate": "2019-08-24T14:15:22Z",
    "startDate": "2019-08-24T14:15:22Z"
  },
  "frequencyType": "rowCount",
  "metricName": "string",
  "modelId": "string",
  "projectId": "string",
  "resolutions": [
    "microseconds"
  ]
}

Responses

Status Meaning Description Schema
200 OK Metadata of the Accuracy Over Time (AOT) chart for an external dataset. AOTChartMetadataResponse
404 Not Found No insights found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/datasetAccuracyOverTimePlots/{datasetId}/preview/

Retrieve a preview of the Accuracy Over Time (AOT) chart for an external dataset. Datetimes are specified in accordance with :ref:timestamp and duration formatting rules <time_format>.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/datasetAccuracyOverTimePlots/{datasetId}/preview/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project id which was used to compute the AOT chart.
modelId path string true The model id which was used to compute the AOT chart.
datasetId path string true The dataset id which was used to compute the AOT chart.

Example responses

200 Response

{
  "bins": [
    {
      "actual": 0,
      "endDate": "2019-08-24T14:15:22Z",
      "frequency": 0,
      "predicted": 0,
      "startDate": "2019-08-24T14:15:22Z"
    }
  ],
  "datasetId": "string",
  "modelId": "string",
  "projectId": "string"
}

Responses

Status Meaning Description Schema
200 OK Preview of the Accuracy Over Time (AOT) chart for an external dataset. AOTChartPreviewResponse
404 Not Found No insights found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/datetimeModels/{modelId}/datetimeTrendPlots/

Computes Datetime Trend plots for time series and OTV projects: * For OTV projects, computes Accuracy over Time plots. * For time series supervised projects, computes both Accuracy over Time plots and Forecast vs Actual plots. .. minversion:: v2.25 * For unsupervised time series and OTV models, computes Anomaly Over Time plots. .. note:: For the multiseries time series projects only first 1000 series in alphabetical order and an average plot for them will be computed. .. note:: Maximum 100 forecast distances can be requested for calculation in time series supervised projects.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/datetimeTrendPlots/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "backtest": 0,
  "forecastDistanceEnd": 1000,
  "forecastDistanceStart": 1000,
  "fullAverage": false,
  "seriesIds": [
    "string"
  ],
  "source": "training"
}

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
body body DatetimeTrendPlotsCreate false none

Example responses

202 Response

{
  "message": "string"
}

Responses

Status Meaning Description Schema
202 Accepted Datetime Trend plots computation job submitted successfully. DatetimeTrendPlotsResponse
422 Unprocessable Entity There were invalid parameters in the submitted request. See the message field for more details. None

Response Headers

Status Header Type Format Description
202 Location string A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/featureEffects/

Retrieve Feature Effects for a model backtest. Feature Effects provides partial dependence and predicted vs actual values for the top 500 features, ordered by feature impact score. The partial dependence shows marginal effect of a feature on the target variable after accounting for the average effects of all other predictive features. It indicates how, holding all other variables except the feature of interest as they were, the value of this feature affects your prediction. If a Feature Effects job was previously submitted for a given backtest, this endpoint will return a response structured as {"message": , "jobId": } where jobId is the ID of the job. Retrieve the job with GET /api/v2/projects/{projectId}/jobs/{jobId}/

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/featureEffects/?backtestIndex=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
source query string false Models data source.
includeIcePlots query string false Indicates whether Individual Conditional Expectation (ICE) plots should be returned.
backtestIndex query string true The backtest index. For example: 0, 1, ..., 20, holdout, startstop.
projectId path string true The project ID
modelId path string true The model ID

Enumerated Values

Parameter Value
source training
source validation
source holdout
includeIcePlots false
includeIcePlots False
includeIcePlots true
includeIcePlots True

Example responses

200 Response

{
  "backtestIndex": "string",
  "featureEffects": [
    {
      "featureImpactScore": 0,
      "featureName": "string",
      "featureType": "string",
      "isBinnable": true,
      "isScalable": true,
      "partialDependence": {
        "data": [
          {
            "dependence": 0,
            "label": "string"
          }
        ],
        "isCapped": true
      },
      "predictedVsActual": {
        "data": [
          {
            "actual": 0,
            "bin": [
              "string"
            ],
            "label": "string",
            "predicted": 0,
            "rowCount": 0
          }
        ],
        "isCapped": true,
        "logScaledData": [
          {
            "actual": 0,
            "bin": [
              "string"
            ],
            "label": "string",
            "predicted": 0,
            "rowCount": 0
          }
        ]
      },
      "weightLabel": "string"
    }
  ],
  "modelId": "string",
  "projectId": "string",
  "source": "string"
}

Responses

Status Meaning Description Schema
200 OK none FeatureEffectsDatetimeResponse
403 Forbidden User does not have permission to view the project. None
404 Not Found Project, model, source, backtest index, or computation results do not exist. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/datetimeModels/{modelId}/featureEffects/

Add a request to the queue to calculate Feature Effects for a backtest. If the job has been previously submitted, the request fails, returning the jobId of the previously submitted job. Use this jobId to check status of the previously submitted job.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/featureEffects/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "backtestIndex": "string",
  "rowCount": 10
}

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
body body FeatureEffectsCreateDatetime false none

Responses

Status Meaning Description Schema
202 Accepted The Feature Effects request for a backtest has been successfully submitted. See Location header. None
403 Forbidden User does not have permission to view or submit jobs for the project. None
404 Not Found Provided project, model, or backtest index does not exist. None
422 Unprocessable Entity Queue submission error. None

Response Headers

Status Header Type Format Description
202 Location string A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/featureEffectsMetadata/

Retrieve Feature Effects metadata for each backtest. Response contains status and available sources for each backtest of the model. One of the provided backtestIndex indexes used for submitting the compute request and retrieving Feature Effects. * Start/stop models contain a single backtestIndex response value of startstop. * Other models contain backtestIndex of 0, 1, ..., holdout. One of the provided source parameters used for retrieving Feature Effects. * Each backtest source can be, at a minimum, training or validation. If holdout is configured for the project, backtestIndex also includes holdout with sources training and holdout. * Source value of training is always available. (versions prior to v2.17 support validation only) * When a start/stop model is trained into validation or holdout without stacked predictions (i.e., no out-of-sample predictions in validation or holdout), validation and holdout sources are not available. * Source holdout is not available when there is no holdout configured for the project.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/featureEffectsMetadata/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "data": [
    {
      "backtestIndex": "string",
      "sources": [
        "training"
      ],
      "status": "INPROGRESS"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none ModelXrayMetadataDatetimeResponse
403 Forbidden User does not have permission to view the project. None
404 Not Found Project or model does not exist. None
422 Unprocessable Entity The model is not datetime partitioned. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/featureFit/

NOTE: Starting from API v2.29 this endpoint will be deprecated. Retrieve Feature Fit for a model backtest. Feature Fit provides partial dependence and predicted vs actual values for the top 500 features, ordered by feature importance score. The partial dependence shows marginal effect of a feature on the target variable after accounting for the average effects of all other predictive features. It indicates how, holding all other variables except the feature of interest as they were, the value of this feature affects your prediction. If a Feature Fit job was previously submitted for a given backtest, this endpoint will return a response structured as {"message": , "jobId": } where jobId is the ID of the job. Retrieve the job with GET /api/v2/projects/{projectId}/jobs/{jobId}/

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/featureFit/?backtestIndex=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
source query string false Models data source.
includeIcePlots query string false Indicates whether Individual Conditional Expectation (ICE) plots should be returned.
backtestIndex query string true The backtest index. For example: 0, 1, ..., 20, holdout, startstop.
projectId path string true The project ID
modelId path string true The model ID

Enumerated Values

Parameter Value
source training
source validation
source holdout
includeIcePlots false
includeIcePlots False
includeIcePlots true
includeIcePlots True

Example responses

200 Response

{
  "backtestIndex": "string",
  "featureFit": [
    {
      "featureImportanceScore": 0,
      "featureName": "string",
      "featureType": "string",
      "isBinnable": true,
      "isScalable": true,
      "partialDependence": {
        "data": [
          {
            "dependence": 0,
            "label": "string"
          }
        ],
        "isCapped": true
      },
      "predictedVsActual": {
        "data": [
          {
            "actual": 0,
            "bin": [
              "string"
            ],
            "label": "string",
            "predicted": 0,
            "rowCount": 0
          }
        ],
        "isCapped": true,
        "logScaledData": [
          {
            "actual": 0,
            "bin": [
              "string"
            ],
            "label": "string",
            "predicted": 0,
            "rowCount": 0
          }
        ]
      },
      "weightLabel": "string"
    }
  ],
  "modelId": "string",
  "projectId": "string",
  "source": "string"
}

Responses

Status Meaning Description Schema
200 OK none FeatureFitDatetimeResponse
403 Forbidden User does not have permission to view the project. None
404 Not Found Project, model, source, backtest index, or computation results do not exist. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/datetimeModels/{modelId}/featureFit/

NOTE: Starting from API v2.29 this endpoint will be deprecated. Add a request to the queue to calculate Feature Fit for a backtest. If the job has been previously submitted, the request fails, returning the jobId of the previously submitted job. Use this jobId to check status of the previously submitted job.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/featureFit/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "backtestIndex": "string"
}

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
body body ModelXrayCreateDatetime false none

Responses

Status Meaning Description Schema
202 Accepted The Feature Fit request for a backtest has been successfully submitted. See Location header. None
403 Forbidden User does not have permission to view or submit jobs for the project. None
404 Not Found Provided project, model, or backtest index does not exist. None
422 Unprocessable Entity Queue submission error. None

Response Headers

Status Header Type Format Description
202 Location string A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/featureFitMetadata/

NOTE: Starting from API v2.29 this endpoint will be deprecated. Retrieve Feature Fit metadata for each backtest. Response contains status and available sources for each backtest of the model. One of the provided backtestIndex indexes used for submitting the compute request and retrieving Feature Fit. * Start/stop models contain a single backtestIndex response value of startstop. * Other models contain backtestIndex of 0, 1, ..., holdout. One of the provided source parameters used for retrieving Feature Fit. * Each backtest source can be, at a minimum, training or validation. If holdout is configured for the project, backtestIndex also includes holdout with sources training and holdout. * Source value of training is always available. (versions prior to v2.17 support validation only) * When a start/stop model is trained into validation or holdout without stacked predictions (i.e., no out-of-sample predictions in validation or holdout), validation and holdout sources are not available. * Source holdout is not available when there is no holdout configured for the project.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/featureFitMetadata/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "data": [
    {
      "backtestIndex": "string",
      "sources": [
        "training"
      ],
      "status": "INPROGRESS"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none ModelXrayMetadataDatetimeResponse
403 Forbidden User does not have permission to view the project. None
404 Not Found Project or model does not exist. None
422 Unprocessable Entity The model is not datetime partitioned. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/forecastDistanceStabilityPlot/

Retrieve a plot displaying the stability of the time series model across different forecast distances. .. note:: All durations and datetimes are specified in accordance with the :ref:timestamp and duration formatting rules <time_format>.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/forecastDistanceStabilityPlot/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
metricName query string false The name of the metric to retrieve the scores for. If omitted, the default project metric will be used.
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "endDate": "2019-08-24T14:15:22Z",
  "forecastDistancePlotData": [
    {
      "backtestingScore": 0,
      "forecastDistance": 0,
      "holdoutScore": 0,
      "validationScore": 0
    }
  ],
  "metricName": "string",
  "startDate": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK Forecast distance stability plot for datetime partitioned model. ForecastDistanceStabilityPlotResponse
422 Unprocessable Entity There was an error while retrieving the plot. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/forecastVsActualPlots/

Retrieve the data for the Forecast vs Actual plots.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/forecastVsActualPlots/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
seriesId query string false The name of the series to retrieve. Only available for time series multiseries projects. If not provided an average plot for the first 1000 series will be retrieved.
backtest query any false Retrieve plots for a specific backtest (use the backtest index starting from zero) or holdout. If not specified the first backtest (backtest index 0) will be used.
source query string false The source of the data for the backtest/holdout.
resolution query string false Specifying at which resolution the data should be binned. If not specified, optimal resolution will be used to build chart data with number of bins <= maxBinSize
forecastDistanceStart query integer false The start of forecast distance range (forecast window) to retrieve. If not specified, the first forecast distance for this project will be used. Forecast distance specifies the number of time steps between the predicted point and the origin point. Only available for time series supervised projects.
forecastDistanceEnd query integer false The end of forecast distance range (forecast window) to retrieve. If not specified, the last forecast distance for this project will be used. Forecast distance specifies the number of time steps between the predicted point and the origin point. Only available for time series supervised projects.
maxBinSize query integer false Specifies the maximum number of bins for the retrieval.
startDate query string(date-time) false The start of the date range to return. If not specified, start date for requested plots will be used.
endDate query string(date-time) false The end of the date range to return. If not specified, end date for requested plots will be used.
projectId path string true The project ID
modelId path string true The model ID

Enumerated Values

Parameter Value
source training
source validation
resolution milliseconds
resolution seconds
resolution minutes
resolution hours
resolution days
resolution weeks
resolution months
resolution quarters
resolution years

Example responses

200 Response

{
  "bins": [
    {
      "actual": 0,
      "endDate": "2019-08-24T14:15:22Z",
      "error": 0,
      "forecasts": [
        0
      ],
      "frequency": 0,
      "normalizedError": 1,
      "startDate": "2019-08-24T14:15:22Z"
    }
  ],
  "calendarEvents": [
    {
      "date": "2019-08-24T14:15:22Z",
      "name": "string",
      "seriesId": "string"
    }
  ],
  "endDate": "2019-08-24T14:15:22Z",
  "forecastDistances": [
    1
  ],
  "resolution": "milliseconds",
  "startDate": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK Forecast vs Actual plots data ForecastVsActualPlotsDataResponse
404 Not Found Forecast vs Actual plots data was not found None
422 Unprocessable Entity Invalid parameters were submitted None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/forecastVsActualPlots/metadata/

Retrieve the metadata for the Forecast vs Actual plots.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/forecastVsActualPlots/metadata/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
seriesId query string false The name of the series to retrieve. Only available for time series multiseries projects. If not provided a metadata of average plot for the first 1000 series will be retrieved.
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "backtestMetadata": [
    {
      "training": {
        "endDate": "2019-08-24T14:15:22Z",
        "startDate": "2019-08-24T14:15:22Z"
      },
      "validation": {
        "endDate": "2019-08-24T14:15:22Z",
        "startDate": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "backtestStatuses": [
    {
      "training": {
        "completed": [
          1
        ],
        "errored": [
          1
        ],
        "inProgress": [
          1
        ],
        "insufficientData": [
          1
        ],
        "notCompleted": [
          1
        ]
      },
      "validation": {
        "completed": [
          1
        ],
        "errored": [
          1
        ],
        "inProgress": [
          1
        ],
        "insufficientData": [
          1
        ],
        "notCompleted": [
          1
        ]
      }
    }
  ],
  "estimatedSeriesLimit": 1,
  "holdoutMetadata": {
    "training": {
      "endDate": "2019-08-24T14:15:22Z",
      "startDate": "2019-08-24T14:15:22Z"
    },
    "validation": {
      "endDate": "2019-08-24T14:15:22Z",
      "startDate": "2019-08-24T14:15:22Z"
    }
  },
  "holdoutStatuses": {
    "training": {
      "completed": [
        1
      ],
      "errored": [
        1
      ],
      "inProgress": [
        1
      ],
      "insufficientData": [
        1
      ],
      "notCompleted": [
        1
      ]
    },
    "validation": {
      "completed": [
        1
      ],
      "errored": [
        1
      ],
      "inProgress": [
        1
      ],
      "insufficientData": [
        1
      ],
      "notCompleted": [
        1
      ]
    }
  },
  "resolutions": [
    "milliseconds"
  ]
}

Responses

Status Meaning Description Schema
200 OK Forecast vs Actual plots metadata ForecastVsActualPlotsMetadataResponse
404 Not Found Forecast vs Actual plots metadata was not found None
422 Unprocessable Entity Invalid parameters were submitted None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/forecastVsActualPlots/preview/

Retrieve the preview for the Forecast vs Actual plots.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/forecastVsActualPlots/preview/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
seriesId query string false The name of the series to retrieve. Only available for time series multiseries projects. If not provided an average plot for the first 1000 series will be retrieved.
backtest query any false Retrieve plots for a specific backtest (use the backtest index starting from zero) or holdout. If not specified the first backtest (backtest index 0) will be used.
source query string false The source of the data for the backtest/holdout.
projectId path string true The project ID
modelId path string true The model ID

Enumerated Values

Parameter Value
source training
source validation

Example responses

200 Response

{
  "bins": [
    {
      "actual": 0,
      "endDate": "2019-08-24T14:15:22Z",
      "predicted": 0,
      "startDate": "2019-08-24T14:15:22Z"
    }
  ],
  "endDate": "2019-08-24T14:15:22Z",
  "startDate": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK Forecast vs Actual plots preview DatetimeTrendPlotsPreviewResponse
404 Not Found Forecast vs Actual plots preview was not found None
422 Unprocessable Entity Invalid parameters were submitted None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/multiclassFeatureEffects/

Retrieve feature effects for each class in a multiclass datetime model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/multiclassFeatureEffects/?backtestIndex=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
source query string false Models data source.
includeIcePlots query string false Indicates whether Individual Conditional Expectation (ICE) plots should be returned.
backtestIndex query string true The backtest index. For example: 0, 1, ..., 20, holdout, startstop.
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
class query string false Target class label.
projectId path string true The project ID
modelId path string true The model ID

Enumerated Values

Parameter Value
source training
source validation
source holdout
includeIcePlots false
includeIcePlots False
includeIcePlots true
includeIcePlots True

Example responses

200 Response

{
  "backtestIndex": "string",
  "count": 0,
  "data": [
    {
      "class": "string",
      "featureImpactScore": 0,
      "featureName": "string",
      "featureType": "string",
      "isBinnable": true,
      "isScalable": true,
      "partialDependence": {
        "data": [
          {
            "dependence": 0,
            "label": "string"
          }
        ],
        "isCapped": true
      },
      "predictedVsActual": {
        "data": [
          {
            "actual": 0,
            "bin": [
              "string"
            ],
            "label": "string",
            "predicted": 0,
            "rowCount": 0
          }
        ],
        "isCapped": true,
        "logScaledData": [
          {
            "actual": 0,
            "bin": [
              "string"
            ],
            "label": "string",
            "predicted": 0,
            "rowCount": 0
          }
        ]
      },
      "weightLabel": "string"
    }
  ],
  "modelId": "string",
  "next": "http://example.com",
  "previous": "http://example.com",
  "projectId": "string",
  "source": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none MulticlassDatetimeFeatureEffectsResponse
403 Forbidden User does not have permission to view the project. None
404 Not Found Project, model, source or computation results do not exist. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/datetimeModels/{modelId}/multiclassFeatureEffects/

Compute feature effects for a multiclass datetime model. If the job has been previously submitted, the request fails, returning the jobId of the previously submitted job. Use this jobId to check status of the previously submitted job. NOTE: feature effects are computed for top 100 classes.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/multiclassFeatureEffects/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "backtestIndex": "string",
  "features": [
    "string"
  ],
  "rowCount": 10,
  "topNFeatures": 0
}

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
body body MulticlassFeatureEffectDatetimeCreate false none

Responses

Status Meaning Description Schema
202 Accepted The Feature Effects request has been successfully submitted. See Location header. None
403 Forbidden User does not have permission to view or submit jobs for the project. None
404 Not Found Project, model, source or computation results do not exist. None
422 Unprocessable Entity Queue submission error. If the rowCount exceeds the maximum or minimum value for this dataset. Minimum is 10 rows. Maximum is 100000 rows or the training sample size of the model, whichever is less. If invalid class names are provided in classes.If neither features nor topNFeatures is provided. If invalid backtestIndex is provided. None

Response Headers

Status Header Type Format Description
202 Location string A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/multiseriesHistograms/

Retrieve the histograms for series insights.

Histogram is computed only for first 1000 series (ordered by name).

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/multiseriesHistograms/?attribute=rowCount&bins=10 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
attribute query string true The series attribute to build a histogram for.
metric query string false The name of the metric to retrieve the histogram for attributes "validationScore", "backtestingScore", and"holdoutScore". If omitted, the default project metric will be used.
bins query string true The number of bins in a histogram. Can be 10, 20 or 50. The default is 10.
projectId path string true The project ID
modelId path string true The model ID

Enumerated Values

Parameter Value
attribute rowCount
attribute duration
attribute startDate
attribute endDate
attribute targetAverage
attribute validationScore
attribute backtestingScore
attribute holdoutScore
attribute rowPercent
attribute clusterCount
attribute clustering
bins 10
bins 20
bins 50

Example responses

200 Response

{
  "bins": [
    {
      "count": 0,
      "left": 0,
      "right": 0
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Retrieve the histograms for series insights in form of an array of histogram bins. MultiseriesHistogramsRetrieveResponse
403 Forbidden User does not have permissions to manage models. None
404 Not Found Model with specified modelId doesn't exist, or user does not have access to the project. None
422 Unprocessable Entity Metric provided to query is not found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/multiseriesScores/

List the scores per individual series for the specified multiseries model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/multiseriesScores/?offset=0&limit=100 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
multiseriesValue query string false Only the series containing the given value in one of the series ID columns will be returned if specified.
offset query integer true The number of results to skip. Defaults to 0 if not specified.
limit query integer true The maximum number of results to return. Defaults to 100 if not specified.
metric query string false The name of the metric to retrieve the scores for.If omitted, the default project metric will be used.
orderBy query string false Used for sorting the series. Supported attributes for ordering include: "multiseriesValue", "rowCount", "validationScore", "holdoutScore" and "backtestingScore", "startDate", "endDate", and "targetAverage".Prefix the attribute name with a dash to sort in descending order,e.g. orderBy=-rowCount. If multiple series with equal values of the ordering attributeexist, ties will be broken arbitrarily.
filterBy query string false Used to specify on which attribute values to filter the series.Supported attributes for filtering include: "rowCount", "startDate", "endDate", "targetAverage", "validationScore", "holdoutScore", and "backtestingScore".filterByBins and numberOfBins are required if this parameter is used.
numberOfBins query string false Used to specify the number of bins in the histogram on which to filter the series.Can be 10, 20 or 50.filterBy and filterByBins are required if this parameter is used.
filterByBins query string false Used to specify the multiseries histogram bins on which to filter the series.filterBy and numberOfBins are required if this parameter is used.
clusterNames query string false Used to specify the specific cluster on which to filter the series.filterBy is required if this parameter is used.Only valid for unsupervised clustering projects.
projectId path string true The project ID
modelId path string true The model ID

Enumerated Values

Parameter Value
orderBy multiseriesValue
orderBy -multiseriesValue
orderBy rowCount
orderBy -rowCount
orderBy startDate
orderBy -startDate
orderBy endDate
orderBy -endDate
orderBy targetAverage
orderBy -targetAverage
orderBy validationScore
orderBy -validationScore
orderBy backtestingScore
orderBy -backtestingScore
orderBy holdoutScore
orderBy -holdoutScore
orderBy cluster
orderBy -cluster
filterBy rowCount
filterBy startDate
filterBy endDate
filterBy targetAverage
filterBy validationScore
filterBy backtestingScore
filterBy holdoutScore
filterBy cluster
numberOfBins 10
numberOfBins 20
numberOfBins 50

Example responses

200 Response

{
  "data": [
    {
      "backtestingScore": 0,
      "cluster": "string",
      "duration": "string",
      "endDate": "2019-08-24T14:15:22Z",
      "holdoutScore": 0,
      "multiseriesId": "string",
      "multiseriesValues": [
        "string"
      ],
      "rowCount": 0,
      "startDate": "2019-08-24T14:15:22Z",
      "targetAverage": "string",
      "validationScore": 0
    }
  ],
  "next": "string",
  "previous": "string",
  "querySeriesCount": 0,
  "totalSeriesCount": 0
}

Responses

Status Meaning Description Schema
200 OK Retrieve the accuracy scores for each series for the specified multiseries model. SeriesAccuracyRetrieveResponse
403 Forbidden User does not have permissions to manage models. None
404 Not Found Model with specified modelId doesn't exist, or user does not have access to the project. None
422 Unprocessable Entity Metric provided to query is not found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/datetimeModels/{modelId}/multiseriesScores/

Request the computation of per-series scores for a multiseries model. .. note:: Computation uses available partitions only. This endpoint will not compute backtesting scores if no backtesting scores exist prior to this request.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/multiseriesScores/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "computeAllSeries": false
}

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
body body SeriesAccuracyCompute false none

Responses

Status Meaning Description Schema
202 Accepted Multiseries score computation has been successfully requested. None

Response Headers

Status Header Type Format Description
202 Location string A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/datetimeModels/{modelId}/multiseriesScores/file/

Retrieve the CSV file for the series accuracy.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/datetimeModels/{modelId}/multiseriesScores/file/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
multiseriesValue query string false If specified, only the series containing the given value in one of the series ID columns will be returned.
metric query string false The name of the metric to retrieve the scores for. If omitted, the default project metric will be used.
projectId path string true The project ID
modelId path string true The model ID

Responses

Status Meaning Description Schema
200 OK The response will contain a file containing the series accuracy data in csv format. None
403 Forbidden User does not have permissions to manage models. None
404 Not Found Model with specified modelId doesn't exist, or user does not have access to the project. None
422 Unprocessable Entity Metric provided to query is not found. None

Response Headers

Status Header Type Format Description
200 Content-Disposition string Contains an auto generated filename for this download ("attachment;filename=Series accuracy (model:) ().csv").
200 Content-Type string MIME type of the returned data

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/externalScores/

List of scores on prediction datasets for a project with filtering option by dataset or model or both of them. Prediction dataset may have scores if it contained a column with actual values and predictions were computed on this dataset.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/externalScores/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
datasetId query string false If provided will return scores for dataset with matching datasetId.
modelId query string false If provided will return scores for model with matching modelId.
projectId path string true The project ID

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "actualValueColumn": "string",
      "datasetId": "string",
      "modelId": "string",
      "projectId": "string",
      "scores": [
        {
          "label": "string",
          "value": 0
        }
      ]
    }
  ],
  "next": "string",
  "previous": "string"
}

Responses

Status Meaning Description Schema
200 OK List of scores on prediction datasets. ExternalScoresListResponse
404 Not Found Project not found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/externalScores/

Compute model scores for external dataset, first upload your dataset to the project, and then using the corresponding datasetId, compute scores against that dataset. Computing external scores and insights depends on computed prediction, predictions will be computed if they are not available for this dataset. In order to compute scores and insights, uploaded dataset should contain actual value column. This api is not available in time series projects.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/externalScores/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "actualValueColumn": "string",
  "datasetId": "string",
  "modelId": "string"
}

Parameters

Name In Type Required Description
projectId path string true The project ID
body body ExternalScoresCreate false none

Responses

Status Meaning Description Schema
202 Accepted none None
422 Unprocessable Entity The project type does not support or modeling is not finished yet. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/featureAssociationFeaturelists/

List all featurelists with feature association matrix availability flags for a project.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/featureAssociationFeaturelists/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID

Example responses

200 Response

{
  "featurelists": [
    {
      "featurelistId": "string",
      "hasFam": true,
      "title": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK List available Feature Association Matrix for a project. FeatureAssociationListControllerResponse
404 Not Found Project not found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/featureAssociationMatrix/

Retrieval for pairwise feature association statistics. Projects created prior to v2.17 are not supported by this feature.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/featureAssociationMatrix/?type=association&metric=mutualInfo \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
type query string true the type of dependence for the data. Must be either association or correlation. Since v2.19 this is optional and defaults to association.
metric query string true the name of a metric to get pairwise data for. Must be one of mutualInfo, cramersV, spearman, pearson, or tau. Since v2.19 this is optional and defaults to mutualInfo.
featurelistId query string false the feature list to lookup FAM data for. By default, depending on the type of the project Informative Features or Timeseries Informative Features list will be used.
projectId path string true The project ID

Enumerated Values

Parameter Value
type association
type correlation
metric mutualInfo
metric cramersV
metric spearman
metric pearson
metric tau

Example responses

200 Response

{
  "features": [
    {
      "alphabeticSortIndex": 0,
      "clusterId": 0,
      "clusterName": "string",
      "clusterSortIndex": 0,
      "feature": "string",
      "importanceSortIndex": 0,
      "strengthSortIndex": 0
    }
  ],
  "strengths": [
    {
      "feature1": "string",
      "feature2": "string",
      "statistic": 0
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Retrieve Feature Association Matrix for project. FeatureAssociationRetrieveControllerResponse
404 Not Found Wrong query parameters specified or no such projectId exists. None
422 Unprocessable Entity The project does not support feature associations. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/featureAssociationMatrix/

Compute feature association matrix for given featurelist.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/featureAssociationMatrix/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "featurelistId": "string"
}

Parameters

Name In Type Required Description
projectId path string true The project ID
body body FeatureAssociationCreatePayload false none

Responses

Status Meaning Description Schema
202 Accepted none None
404 Not Found A project with projectId or a featurelist with featurelistId was not found. None
422 Unprocessable Entity The feature association matrix calculation is not supported for this project. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/featureAssociationMatrixDetails/

Retrieval for feature association plotting between a pair of features. Projects created prior to v2.17 are not supported by this feature.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/featureAssociationMatrixDetails/?feature1=string&feature2=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
feature1 query string true The name of a feature.
feature2 query string true the name of another feature.
featurelistId query string false the feature list to lookup FAM data for. By default, depending on the type of the project Informative Features or Timeseries Informative Features list will be used.
projectId path string true The project ID

Example responses

200 Response

{
  "chartType": "string",
  "features": [
    "string"
  ],
  "types": [
    "CATEGORICAL"
  ],
  "values": [
    [
      "string"
    ]
  ]
}

Responses

Status Meaning Description Schema
200 OK Retrieval for feature association plotting between a pair of features. FeatureAssociationDetailsRetrieveControllerResponse
404 Not Found Wrong query parameters specified or no such projectId exists. None
422 Unprocessable Entity This project does not support feature associations, (e.g. multilabel, multiseries, time series unsupervised projects.). None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/features/{featureName}/frequentValues/

Retrieve the frequent values information for a particular feature. Only valid for numeric features. This route returns information about the frequent values seen for a particular feature, based on the EDA sample of the dataset. Up to 60 values will be returned, and when more values are present, they will be bucketed into a level called "==All Other==" at the end of the response.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/features/{featureName}/frequentValues/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true project id
featureName path string true name of the feature

Example responses

200 Response

{
  "frequentValues": [
    {
      "count": 0,
      "dataQuality": "string",
      "target": 0,
      "value": 0
    }
  ],
  "name": "string",
  "numRows": 0,
  "projectId": "string"
}

Responses

Status Meaning Description Schema
200 OK Retrieve the frequent values information for a particular feature. FrequentValuesResponse
404 Not Found If the feature doesn't exist, or no such projectId exists None
422 Unprocessable Entity If the feature isn't numeric None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/geometryFeaturePlots/

Create a map of one location feature

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/geometryFeaturePlots/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "feature": "string"
}

Parameters

Name In Type Required Description
projectId path string true Project Id. It is the project to select the location feature from.
body body GeometryFeaturePLotCreatePayload false none

Responses

Status Meaning Description Schema
202 Accepted Create a map of one location feature None
422 Unprocessable Entity Unprocessed Entity None

Response Headers

Status Header Type Format Description
202 Location string A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/geometryFeaturePlots/{featureName}/

Retrieve a map of one location feature

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/geometryFeaturePlots/{featureName}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true Project Id. It is the project to select the feature from.
featureName path string true Name of location feature to plot on map. Must be supplied in order to determine which plot to retrieve.

Example responses

200 Response

{
  "feature": "string",
  "plotData": {
    "aggregation": "grid",
    "bbox": {},
    "features": [
      {
        "geometry": {
          "coordinates": [
            {}
          ],
          "type": "Point"
        },
        "properties": {
          "count": 0
        },
        "type": "string"
      }
    ],
    "summary": {
      "maxCount": 0,
      "minCount": 0,
      "totalCount": 0
    },
    "type": "string",
    "valueAggregation": "geometry"
  },
  "projectId": "string"
}

Responses

Status Meaning Description Schema
200 OK Retrieve the map of one location feature GeometryFeaturePlotRetrieveResponse
404 Not Found Map of feature not found None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/models/{modelId}/anomalyAssessmentInitialization/

Initialize the anomaly assessment insight and calculate Shapley explanations for the most anomalous points in the subset. The insight is available for anomaly detection models in time series unsupervised projects which also support calculation of Shapley values.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/anomalyAssessmentInitialization/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "backtest": 19,
  "seriesId": "string",
  "source": "training"
}

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
body body AnomalyAssessmentInitialize false none

Responses

Status Meaning Description Schema
202 Accepted Job submitted. See Location header. None

Response Headers

Status Header Type Format Description
202 Location string A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/anomalyInsightsFile/

Retrieve a CSV file of the raw data displayed with the anomaly score from the specific model. The number of rows included will be set by the expected outlier fraction but up to a maximum of 1000 rows. Only models built from anomaly detection blueprints have those insights.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/anomalyInsightsFile/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
filename query string false name of the file to generate and return
projectId path string true The project ID
modelId path string true The model ID

Responses

Status Meaning Description Schema
200 OK Retrieve a CSV file of the raw data displayed with the anomaly score from the model. None
404 Not Found project Id / model Id does not exist or model doesn't have anomaly insights table. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/anomalyInsightsTable/

Retrieve a table of the raw data displayed with the anomaly score from the specific model. The number of rows displayed is limited to 100 rows by the ANOMALY_INSIGHT_SAMPLE_ROW_COUNT configuration setting. Additionally, feature column count and the size of data in text fields is also limited. Only models built from anomaly detection blueprints have those insights.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/anomalyInsightsTable/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
anomalyScoreRounding query integer false number of decimals each element anomalyScore column will be rounded to.
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "modelId": "string",
  "table": [
    {
      "columns": [
        "string"
      ],
      "data": [
        0
      ],
      "rowId": [
        0
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Retrieve a table of the raw data displayed with the anomaly score from the specific model. AnomalyInsightTableRetrieve
404 Not Found The model doesn't have anomaly insights table. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/clusterInsights/

Retrieve all computed Cluster Insights for a clustering project model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/clusterInsights/?limit=15 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer true At most this many results are returned. The default may change without notice.
orderBy query string false Order results by the specified field value.
searchFor query string false Search for a specific string in a feature name.This search is case insensitive. If not specified, all features will be returned.
projectId path string true The project ID
modelId path string true The model ID

Enumerated Values

Parameter Value
orderBy featureImpact
orderBy -featureImpact
orderBy featureName
orderBy -featureName

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "featureImpact": 0,
      "featureName": "string",
      "featureType": "image",
      "insights": [
        {
          "allData": {
            "images": [
              "string"
            ],
            "percentageOfMissingImages": 100
          },
          "insightName": "representativeImages",
          "perCluster": [
            {
              "clusterName": "string",
              "images": [
                "string"
              ],
              "percentageOfMissingImages": 100
            }
          ]
        }
      ]
    }
  ],
  "isCurrentClusterInsightVersion": true,
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0,
  "version": 0
}

Responses

Status Meaning Description Schema
200 OK Insights for a clustering project model. ClusterInsightsPaginatedResponse
404 Not Found The project or the model was not found or insights have not been computed yet. None
422 Unprocessable Entity Feature Impact is required. Please, compute it first. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/models/{modelId}/clusterInsights/

Compute Cluster Insights for a clustering project model.The number of features computed for cluster insights are capped at 100, starting with the features used to train the model sorted by feature impact (high to low), and then the remaining features in the dataset alphabetically.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/clusterInsights/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{}

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
body body Empty false none

Example responses

202 Response

{}

Responses

Status Meaning Description Schema
202 Accepted A URI of the newly submitted job in the "Location" header. Empty
404 Not Found The project or the model was not found or insights have not been computed yet. None
422 Unprocessable Entity Feature Impact is already in progress or Cluster Insighst is already in progress, but we were unable to find the previous job. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/clusterInsights/download/

Download all computed Cluster Insights for a clustering project model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/clusterInsights/download/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
format query string false A format to use.
featurelistId query string false The ID of the featurelist to download data for. If not specified all columns will be downloaded.
projectId path string true The project ID
modelId path string true The model ID

Enumerated Values

Parameter Value
format CSV

Responses

Status Meaning Description Schema
200 OK A file with insights for a clustering project model. None
404 Not Found The project or the model was not found or insights have not been computed yet. None
422 Unprocessable Entity Feature Impact is required. Please, compute it first. None

Response Headers

Status Header Type Format Description
200 Content-Disposition string Contains an auto generated filename for this download ("attachment;filename=cluster_insights__.csv").

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/confusionCharts/

    Retrieve all available confusion charts for model. The response will
    include a json array of all available confusion charts, in the same format as the response
    from [GET /api/v2/projects/{projectId}/models/{modelId}/confusionCharts/{source}/][get-apiv2projectsprojectidmodelsmodelidconfusionchartssource].
    .. note:: Available for multiclass projects only.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/confusionCharts/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "charts": [
    {
      "columns": [
        0
      ],
      "data": {
        "classMetrics": [
          {
            "actualCount": 0,
            "className": "string",
            "confusionMatrixOneVsAll": [
              [
                0
              ]
            ],
            "f1": 0,
            "precision": 0,
            "predictedCount": 0,
            "recall": 0,
            "wasActualPercentages": [
              {
                "otherClassName": "string",
                "percentage": 0
              }
            ],
            "wasPredictedPercentages": [
              {
                "otherClassName": "string",
                "percentage": 0
              }
            ]
          }
        ],
        "classes": [
          "string"
        ],
        "colClasses": [
          "string"
        ],
        "confusionMatrix": [
          [
            0
          ]
        ],
        "rowClasses": [
          "string"
        ]
      },
      "numberOfClasses": 0,
      "rows": [
        0
      ],
      "source": "validation",
      "totalMatrixSum": 0
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK All of the available confusion charts for a model. ModelConfusionChartListResponse
404 Not Found No confusion chart available. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/confusionCharts/{source}/

    Retrieve the confusion chart data from a single source. A confusion chart consists of the confusion matrix for all classes, classes frequencies and `oneVsAll` metrics for all classes. The confusion matrix can be requested in a particular sort order and orientated by rows or columns. A subset of the confusion matrix can also be requested in part by specifying slicing indices. Throughout the following specification, `C` refers to the total number of classes in the dataset. The full confusion matrix refers to the confusion matrix with `C` classes.

    .. note:: Available for multiclass projects only.

    An example on the meaning of wasActualPercentages and wasPredictedPercentages:
    Let's say we have the following data:
    .. code-block:: js


       classMetrics.classA.wasActualPercentages[0].percentage = 0.56
       classMetrics.classA.wasPredictedPercentages[0].percentage = 0.62
       classA.wasActualPercentages[0].otherClassName = "classB"
       classA.wasPredictedPercentages[0].otherClassName = "classB"


    That means:

    1) "Given that it was actually classA, it predicted classB 56% of the time".
    2) "Given that classA was predicted, it was actually classB 62% of the time".

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/confusionCharts/{source}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
orderBy query string false Ordering the chart data by following attributes.Prefix the attribute name with a dash to sort in descending order, e.g. orderBy='-predictedCount'
orientation query string false Determines whether the values in the rows of the confusion matrix should correspond to the same actual class ('actual') or predicted class ('predicted').
rowStart query integer false start index of row for slicing the confusion matrix.
rowEnd query integer false end index of row for slicing the confusion matrix.
colStart query integer false start index of column for slicing the confusion matrix.
colEnd query integer false end index of column for slicing the confusion matrix.
projectId path string true The project ID
modelId path string true The model ID
source path string true Source of the data

Enumerated Values

Parameter Value
orderBy className
orderBy -className
orderBy actualCount
orderBy -actualCount
orderBy predictedCount
orderBy -predictedCount
orderBy f1
orderBy -f1
orientation actual
orientation -actual
orientation predicted
orientation -predicted
source backtest_6
source backtest_7
source backtest_11
source backtest_10
source backtest_8
source backtest_12
source backtest_4
source backtest_13
source backtest_3
source validation
source backtest_20
source backtest_19
source backtest_17
source backtest_9
source crossValidation
source backtest_18
source backtest_2
source backtest_15
source backtest_5
source backtest_14
source backtest_16
source holdout

Example responses

200 Response

{
  "columns": [
    0
  ],
  "data": {
    "classMetrics": [
      {
        "actualCount": 0,
        "className": "string",
        "confusionMatrixOneVsAll": [
          [
            0
          ]
        ],
        "f1": 0,
        "precision": 0,
        "predictedCount": 0,
        "recall": 0,
        "wasActualPercentages": [
          {
            "otherClassName": "string",
            "percentage": 0
          }
        ],
        "wasPredictedPercentages": [
          {
            "otherClassName": "string",
            "percentage": 0
          }
        ]
      }
    ],
    "classes": [
      "string"
    ],
    "colClasses": [
      "string"
    ],
    "confusionMatrix": [
      [
        0
      ]
    ],
    "rowClasses": [
      "string"
    ]
  },
  "numberOfClasses": 0,
  "rows": [
    0
  ],
  "source": "validation",
  "totalMatrixSum": 0
}

Responses

Status Meaning Description Schema
200 OK The confusion chart data from a single source. ModelConfusionChartRetrieveResponse
404 Not Found No confusion chart for source. None
422 Unprocessable Entity Invalid indices for confusion matrix. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/confusionCharts/{source}/classDetails/

    Calculates and sends frequency of class in distributed among other
    classes for actual and predicted data. A confusion chart class details for given class gives
    stats of misclassification done by model for given class for actual and predicted data.
    .. note:: Available for multiclass projects only.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/confusionCharts/{source}/classDetails/?className=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
className query string true Name of a class for which distribution frequency is requested.
projectId path string true The project ID
modelId path string true The model ID
source path string true Source of the data

Enumerated Values

Parameter Value
source backtest_6
source backtest_7
source backtest_11
source backtest_10
source backtest_8
source backtest_12
source backtest_4
source backtest_13
source backtest_3
source validation
source backtest_20
source backtest_19
source backtest_17
source backtest_9
source crossValidation
source backtest_18
source backtest_2
source backtest_15
source backtest_5
source backtest_14
source backtest_16
source holdout

Example responses

200 Response

{
  "actualFrequency": [
    {
      "otherClassName": "string",
      "percentage": 100,
      "value": 0
    }
  ],
  "className": "string",
  "predictedFrequency": [
    {
      "otherClassName": "string",
      "percentage": 100,
      "value": 0
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK The details of the confusion matrix of a model for a specific class. ModelConfusionChartClassDetailsRetrieveReponseController
404 Not Found No confusion chart for source. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/confusionCharts/{source}/metadata/

    Retrieve metadata for the confusion chart of a model.
    .. note:: Available for multiclass projects only.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/confusionCharts/{source}/metadata/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
orderBy query string false Ordering the chart data by following attributes.Prefix the attribute name with a dash to sort in descending order, e.g. orderBy='-predictedCount'
orientation query string false Determines whether the values in the rows of the confusion matrix should correspond to the same actual class ('actual') or predicted class ('predicted').
thumbnailCellSize query integer false Number of classes in a single 'thumbnail' cell.
projectId path string true The project ID
modelId path string true The model ID
source path string true Source of the data

Enumerated Values

Parameter Value
orderBy className
orderBy -className
orderBy actualCount
orderBy -actualCount
orderBy predictedCount
orderBy -predictedCount
orderBy f1
orderBy -f1
orientation actual
orientation -actual
orientation predicted
orientation -predicted
source backtest_6
source backtest_7
source backtest_11
source backtest_10
source backtest_8
source backtest_12
source backtest_4
source backtest_13
source backtest_3
source validation
source backtest_20
source backtest_19
source backtest_17
source backtest_9
source crossValidation
source backtest_18
source backtest_2
source backtest_15
source backtest_5
source backtest_14
source backtest_16
source holdout

Example responses

200 Response

{
  "classNames": [
    "string"
  ],
  "relevantClassesPositions": [
    [
      1
    ]
  ],
  "source": "validation",
  "totalMatrixSum": 0
}

Responses

Status Meaning Description Schema
200 OK The metadata for the confusion chart of a model. ModelConfusionChartMetadataRetrieveResponse
404 Not Found No confusion chart for source. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/crossClassAccuracyScores/

Retrieves a list of Cross Class Accuracy scores for the model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/crossClassAccuracyScores/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer false Number of items to skip. Defaults to 0 if not provided.
limit query integer false Number of items to return, defaults to 100 if not provided.
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "feature": "string",
      "modelId": "string",
      "perClassAccuracyScores": [
        {
          "className": "string",
          "metrics": [
            {
              "metric": "AUC",
              "value": 1
            }
          ]
        }
      ],
      "predictionThreshold": 1
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Returns Cross Class Accuracy scores. CrossClassAccuracyList

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/models/{modelId}/crossClassAccuracyScores/

Submits a job to start Cross Class Accuracy scores calculations for the model.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/crossClassAccuracyScores/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

202 Response

{
  "statusId": "string"
}

Responses

Status Meaning Description Schema
202 Accepted Job submitted. See Location header. CrossClassAccuracyCreateResponse

Response Headers

Status Header Type Format Description
202 Location string A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/dataDisparityInsights/

Retrieve a list of Cross Class Data Disparity insights for the model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/dataDisparityInsights/?feature=string&className1=string&className2=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer false Number of items to skip. Defaults to 0 if not provided.
limit query integer false Number of items to return, defaults to 100 if not provided.
feature query string true Feature for which insight is computed.
className1 query string true One of the compared classes.
className2 query string true Another compared class.
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "count": 0,
  "data": {
    "features": [
      {
        "detailsHistogram": [
          {
            "bars": [
              {
                "label": "string",
                "value": 0
              }
            ],
            "bin": "string"
          }
        ],
        "disparityScore": 0,
        "featureImpact": 0,
        "name": "string",
        "status": "Healthy"
      }
    ],
    "metric": "string",
    "protectedFeature": "string",
    "values": [
      {
        "count": 0,
        "label": "string"
      }
    ]
  },
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Returns Cross Class Data Disparity results. DataDisparityRetrieveResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/models/{modelId}/dataDisparityInsights/

Submits a job to start Cross Class Data Disparity insight calculations.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/dataDisparityInsights/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "comparedClassNames": [
    "string",
    "string"
  ],
  "feature": "string"
}

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
body body DataDisparityCreatePayload false none

Example responses

202 Response

{
  "statusId": "string"
}

Responses

Status Meaning Description Schema
202 Accepted Job submitted. See Location header. DataDisparityCreateResponse

Response Headers

Status Header Type Format Description
202 Location string A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/datasetConfusionCharts/

List of Confusion Charts objects on external datasets for a project with filtering option by dataset. Prediction dataset may have Confusion Chart for multiclass projects computed if it contained a target with actual values and insights were computed on this dataset. A confusion chart consists of the confusion matrix for all classes, classes frequencies and oneVsAll metrics for all classes. The confusion matrix can be requested in a particular sort order and orientated by rows or columns. Available for multiclass projects only.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/datasetConfusionCharts/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
orderBy query string false Ordering the chart data by following attributes.Prefix the attribute name with a dash to sort in descending order, e.g. orderBy='-predictedCount'
orientation query string false Determines whether the values in the rows of the confusion matrix should correspond to the same actual class ('actual') or predicted class ('predicted').
rowStart query integer false start index of row for slicing the confusion matrix.
rowEnd query integer false end index of row for slicing the confusion matrix.
colStart query integer false start index of column for slicing the confusion matrix.
colEnd query integer false end index of column for slicing the confusion matrix.
datasetId query string false The datasetId to retrieve a Confusion chart from.
projectId path string true The project to retrieve a Confusion chart from.
modelId path string true The model to retrieve a Confusion chart from.

Enumerated Values

Parameter Value
orderBy className
orderBy -className
orderBy actualCount
orderBy -actualCount
orderBy predictedCount
orderBy -predictedCount
orderBy f1
orderBy -f1
orientation actual
orientation -actual
orientation predicted
orientation -predicted

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "columns": [
        0
      ],
      "data": {
        "classMetrics": [
          {
            "actualCount": 0,
            "className": "string",
            "confusionMatrixOneVsAll": [
              [
                0
              ]
            ],
            "f1": 0,
            "precision": 0,
            "predictedCount": 0,
            "recall": 0,
            "wasActualPercentages": [
              {
                "otherClassName": "string",
                "percentage": 0
              }
            ],
            "wasPredictedPercentages": [
              {
                "otherClassName": "string",
                "percentage": 0
              }
            ]
          }
        ],
        "classes": [
          "string"
        ],
        "colClasses": [
          "string"
        ],
        "confusionMatrix": [
          [
            0
          ]
        ],
        "rowClasses": [
          "string"
        ]
      },
      "numberOfClasses": 0,
      "rows": [
        0
      ],
      "source": "validation",
      "totalMatrixSum": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK List of Confusion Charts objects for external datasets. ConfusionChartForDatasetsListResponse
404 Not Found No insights found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/datasetConfusionCharts/{datasetId}/

Retrieve Confusion Chart objects on external datasets for a project. Prediction dataset may have Confusion Chart for multiclass projects computed if it contained a target with actual values and insights were computed on this dataset. A confusion chart consists of the confusion matrix for all classes, classes frequencies and oneVsAll metrics for all classes. The confusion matrix can be requested in a particular sort order and oriented by rows or columns (zero-indexed). Available for multiclass projects only.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/datasetConfusionCharts/{datasetId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
orderBy query string false Ordering the chart data by following attributes.Prefix the attribute name with a dash to sort in descending order, e.g. orderBy='-predictedCount'
orientation query string false Determines whether the values in the rows of the confusion matrix should correspond to the same actual class ('actual') or predicted class ('predicted').
rowStart query integer false start index of row for slicing the confusion matrix.
rowEnd query integer false end index of row for slicing the confusion matrix.
colStart query integer false start index of column for slicing the confusion matrix.
colEnd query integer false end index of column for slicing the confusion matrix.
projectId path string true The project to retrieve a Confusion chart from.
modelId path string true The model to retrieve a Confusion chart from.
datasetId path string true The dataset to retrieve a Confusion chart from.

Enumerated Values

Parameter Value
orderBy className
orderBy -className
orderBy actualCount
orderBy -actualCount
orderBy predictedCount
orderBy -predictedCount
orderBy f1
orderBy -f1
orientation actual
orientation -actual
orientation predicted
orientation -predicted

Example responses

200 Response

{
  "columns": [
    0
  ],
  "data": {
    "classMetrics": [
      {
        "actualCount": 0,
        "className": "string",
        "confusionMatrixOneVsAll": [
          [
            0
          ]
        ],
        "f1": 0,
        "precision": 0,
        "predictedCount": 0,
        "recall": 0,
        "wasActualPercentages": [
          {
            "otherClassName": "string",
            "percentage": 0
          }
        ],
        "wasPredictedPercentages": [
          {
            "otherClassName": "string",
            "percentage": 0
          }
        ]
      }
    ],
    "classes": [
      "string"
    ],
    "colClasses": [
      "string"
    ],
    "confusionMatrix": [
      [
        0
      ]
    ],
    "rowClasses": [
      "string"
    ]
  },
  "datasetId": "string",
  "numberOfClasses": 0,
  "rows": [
    0
  ],
  "totalMatrixSum": 0
}

Responses

Status Meaning Description Schema
200 OK Retrieve Confusion Chart objects on external datasets. ConfusionChartRetrieveForDatasets
404 Not Found No insights found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/datasetConfusionCharts/{datasetId}/classDetails/

Calculate and sends frequency of class in distributed among other classes for actual and predicted data. A confusion chart class details for given class gives stats of misclassification done by model for given class for actual and predicted data. Available for multiclass projects only.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/datasetConfusionCharts/{datasetId}/classDetails/?className=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
className query string true Name of a class for which distribution frequency is requested.
projectId path string true The project to retrieve a Confusion chart from.
modelId path string true The model to retrieve a Confusion chart from.
datasetId path string true The dataset to retrieve a Confusion chart from.

Example responses

200 Response

{
  "actualFrequency": [
    {
      "otherClassName": "string",
      "percentage": 100,
      "value": 0
    }
  ],
  "className": "string",
  "datasetId": "string",
  "modelId": "string",
  "predictedFrequency": [
    {
      "otherClassName": "string",
      "percentage": 100,
      "value": 0
    }
  ],
  "projectId": "string"
}

Responses

Status Meaning Description Schema
200 OK A confusion chart class details for given class. ModelConfusionChartClassDetailsForDatasetRetrieve
404 Not Found No insights found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/datasetConfusionCharts/{datasetId}/metadata/

Retrieve metadata for the confusion chart of a model on external dataset for a project. Available for multiclass projects only.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/datasetConfusionCharts/{datasetId}/metadata/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
orderBy query string false Ordering the chart data by following attributes.Prefix the attribute name with a dash to sort in descending order, e.g. orderBy='-predictedCount'
orientation query string false Determines whether the values in the rows of the confusion matrix should correspond to the same actual class ('actual') or predicted class ('predicted').
thumbnailCellSize query integer false Number of classes in a single 'thumbnail' cell.
projectId path string true The project to retrieve a Confusion chart from.
modelId path string true The model to retrieve a Confusion chart from.
datasetId path string true The dataset to retrieve a Confusion chart from.

Enumerated Values

Parameter Value
orderBy className
orderBy -className
orderBy actualCount
orderBy -actualCount
orderBy predictedCount
orderBy -predictedCount
orderBy f1
orderBy -f1
orientation actual
orientation -actual
orientation predicted
orientation -predicted

Example responses

200 Response

{
  "classNames": [
    "string"
  ],
  "datasetId": "string",
  "modelId": "string",
  "projectId": "string",
  "relevantClassesPositions": [
    [
      0
    ]
  ],
  "totalMatrixSum": 0
}

Responses

Status Meaning Description Schema
200 OK Retrieve metadata for the Confusion Chart objects on external datasets. ConfusionChartRetrieveMetadataForDatasets
404 Not Found No insights found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/datasetLiftCharts/

List of Lift chart objects on prediction datasets for a project with filtering option by dataset. Prediction dataset may have Lift chart computed if it contained a column with actual values and predictions were computed on this dataset. This controller is not supported for multiclass classification projects. For multiclass, instead use /projects//models//datasetMulticlassLiftCharts/.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/datasetLiftCharts/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
datasetId query string false If provided will return Lift chart for dataset with matching datasetId.
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "bins": [
        {
          "actual": 0,
          "binWeight": 0,
          "predicted": 0
        }
      ],
      "datasetId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Responses

Status Meaning Description Schema
200 OK Retrieve List of Lift chart data on prediction datasets. LiftChartForDatasetsList
404 Not Found No insights found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/datasetMulticlassLiftCharts/

List of Multiclass Lift chart objects on prediction datasets for a project with filtering option by dataset. Prediction dataset may have Multiclass Lift chart computed if it contained a column with actual values and predictions were computed on this dataset. Multiclass Lift charts are supported for multiclass classification projects only.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/datasetMulticlassLiftCharts/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
datasetId query string false If provided will return Lift chart for dataset with matching datasetId.
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "classBins": [
        {
          "bins": [
            {
              "actual": 0,
              "binWeight": 0,
              "predicted": 0
            }
          ],
          "targetClass": "string"
        }
      ],
      "datasetId": "string"
    }
  ],
  "modelId": "string",
  "next": "http://example.com",
  "previous": "http://example.com",
  "projectId": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Retrieve List of Multiclass Lift chart data on prediction datasets. MulticlassLiftChartForDatasetsList
404 Not Found No insights found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/datasetResidualsCharts/

List of residuals charts objects on prediction datasets for a project with filtering option by dataset. Prediction dataset may have residuals chart computed if it contained a column with actual values and predictions were computed on this dataset. Residuals charts are supported for regression projects only.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/datasetResidualsCharts/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
datasetId query string false If provided will return ROC curve for dataset with matching datasetId.
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "coefficientOfDetermination": 0,
      "data": [
        [
          0
        ]
      ],
      "datasetId": "string",
      "histogram": [
        {
          "intervalEnd": 0,
          "intervalStart": 0,
          "occurrences": 0
        }
      ],
      "residualMean": 0,
      "standardDeviation": 0
    }
  ],
  "modelId": "string",
  "next": "http://example.com",
  "previous": "http://example.com",
  "projectId": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none ResidualsChartForDatasetsList

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/datasetRocCurves/

List of ROC curve objects on prediction datasets for a project with filtering option by dataset.

Prediction dataset may have ROC curve computed if it contained a column with actual values and predictions were computed on this dataset. Each ROC curve object includes an array of points showing the performance of the model at different thresholds for classification, and arrays of sample predictions for both the positive and negative classes.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/datasetRocCurves/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
datasetId query string false If provided will return ROC curve for dataset with matching datasetId.
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "datasetId": "string",
      "negativeClassPredictions": [
        0
      ],
      "positiveClassPredictions": [
        0
      ],
      "rocPoints": {
        "accuracy": 0,
        "f1Score": 0,
        "falseNegativeScore": 0,
        "falsePositiveRate": 0,
        "falsePositiveScore": 0,
        "fractionPredictedAsNegative": 0,
        "fractionPredictedAsPositive": 0,
        "liftNegative": 0,
        "liftPositive": 0,
        "matthewsCorrelationCoefficient": 0,
        "negativePredictiveValue": 0,
        "positivePredictiveValue": 0,
        "threshold": 0,
        "trueNegativeRate": 0,
        "trueNegativeScore": 0,
        "truePositiveRate": 0,
        "truePositiveScore": 0
      }
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Responses

Status Meaning Description Schema
200 OK Objects were returned successfully. No objects is a valid case. RocCurveForDatasetsList

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/fairnessInsights/

Retrieve a list of Per Class Bias insights for the model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/fairnessInsights/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer false Number of items to skip. Defaults to 0 if not provided.
limit query integer false Number of items to return, defaults to 100 if not provided.
fairnessMetricsSet query string false Metric to use for calculating fairness. Can be one of proportionalParity, equalParity, predictionBalance, trueFavorableAndUnfavorableRateParity or FavorableAndUnfavorablePredictiveValueParity. Used and required only if Bias & Fairness in AutoML feature is enabled.
projectId path string true The project ID
modelId path string true The model ID

Enumerated Values

Parameter Value
fairnessMetricsSet proportionalParity
fairnessMetricsSet equalParity
fairnessMetricsSet predictionBalance
fairnessMetricsSet trueFavorableAndUnfavorableRateParity
fairnessMetricsSet favorableAndUnfavorablePredictiveValueParity

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "fairnessMetric": "proportionalParity",
      "fairnessThreshold": 0.8,
      "modelId": "string",
      "perClassFairness": [
        {
          "absoluteValue": 1,
          "className": "string",
          "entriesCount": 0,
          "isStatisticallySignificant": true,
          "value": 1
        }
      ],
      "predictionThreshold": 1,
      "protectedFeature": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Returns Per Class Bias results. FairnessInsightsListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/models/{modelId}/fairnessInsights/

Submits a job to start Per Class Bias insight calculations for the model.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/fairnessInsights/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "fairnessMetricsSet": "proportionalParity"
}

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
body body FairnessInsightsStartCalculationPayload false none

Example responses

202 Response

{
  "statusId": "string"
}

Responses

Status Meaning Description Schema
202 Accepted Job submitted. See Location header. FairnessInsightsStartCalculationResponse

Response Headers

Status Header Type Format Description
202 Location string A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/featureEffects/

Retrieve Feature Effects for the model. Feature Effects provides partial dependence and predicted vs actual values for the top 500 features, ordered by feature impact score. The partial dependence shows marginal effect of a feature on the target variable after accounting for the average effects of all other predictive features. It indicates how, holding all other variables except the feature of interest as they were, the value of this feature affects your prediction. If a Feature Effects job was previously submitted, this endpoint will return a response structured as {"message": , "jobId": } where jobId is the ID of the job. Retrieve the job with GET /api/v2/projects/{projectId}/jobs/{jobId}/

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/featureEffects/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
source query string false Models data source.
includeIcePlots query string false Indicates whether Individual Conditional Expectation (ICE) plots should be returned.
projectId path string true The project ID
modelId path string true The model ID

Enumerated Values

Parameter Value
source training
source validation
source holdout
includeIcePlots false
includeIcePlots False
includeIcePlots true
includeIcePlots True

Example responses

200 Response

{
  "featureEffects": [
    {
      "featureImpactScore": 0,
      "featureName": "string",
      "featureType": "string",
      "isBinnable": true,
      "isScalable": true,
      "partialDependence": {
        "data": [
          {
            "dependence": 0,
            "label": "string"
          }
        ],
        "isCapped": true
      },
      "predictedVsActual": {
        "data": [
          {
            "actual": 0,
            "bin": [
              "string"
            ],
            "label": "string",
            "predicted": 0,
            "rowCount": 0
          }
        ],
        "isCapped": true,
        "logScaledData": [
          {
            "actual": 0,
            "bin": [
              "string"
            ],
            "label": "string",
            "predicted": 0,
            "rowCount": 0
          }
        ]
      },
      "weightLabel": "string"
    }
  ],
  "modelId": "string",
  "projectId": "string",
  "source": "string"
}

Responses

Status Meaning Description Schema
200 OK none FeatureEffectsResponse
403 Forbidden User does not have permission to view the project. None
404 Not Found Project, model, source or computation results do not exist. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/models/{modelId}/featureEffects/

Add a request to the queue to calculate Feature Effects. If the job has been previously submitted, the request fails, returning the jobId of the previously submitted job. Use this jobId to check status of the previously submitted job.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/featureEffects/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "rowCount": 10
}

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
body body FeatureEffectCreate false none

Responses

Status Meaning Description Schema
202 Accepted The Feature Effects request has been successfully submitted. See Location header. None
403 Forbidden User does not have permission to view or submit jobs for the project. None
404 Not Found Provided project or model does not exist. None
422 Unprocessable Entity Queue submission error.

.. minversion:: v2.21

If the rowCount exceeds the maximum or minimum value for this dataset. Minimum
is 10 rows. Maximum is 100000 rows or the training sample size of the model,
whichever is less.|None|

Response Headers

Status Header Type Format Description
202 Location string A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/featureEffectsMetadata/

Retrieve Feature Effects metadata. Response contains status and available sources. One of the provided source parameters used for retrieving Feature Effects. * Source can be, at a minimum, training or validation. If holdout is configured for the project, source also includes holdout. * Source value of training is always available. (versions prior to v2.17 support validation only) * When a model is trained into validation or holdout without stacked predictions (i.e., no out-of-sample predictions in validation or holdout), validation and holdout sources are not available.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/featureEffectsMetadata/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "sources": [
    "training"
  ],
  "status": "INPROGRESS"
}

Responses

Status Meaning Description Schema
200 OK none ModelXrayMetadataResponse
403 Forbidden User does not have permission to view the project. None
404 Not Found Project or model does not exist. None
422 Unprocessable Entity The model is datetime partitioned. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/featureFit/

NOTE: Starting from API v2.29 this endpoint will be deprecated. Retrieve Feature Fit for the model. Feature Fit provides partial dependence and predicted vs actual values for the top 500 features, ordered by feature importance score. The partial dependence shows marginal effect of a feature on the target variable after accounting for the average effects of all other predictive features. It indicates how, holding all other variables except the feature of interest as they were, the value of this feature affects your prediction. If a Feature Fit job was previously submitted, this endpoint will return a response structured as {"message": , "jobId": } where jobId is the ID of the job. Retrieve the job with GET /api/v2/projects/{projectId}/jobs/{jobId}/

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/featureFit/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
source query string false Models data source.
includeIcePlots query string false Indicates whether Individual Conditional Expectation (ICE) plots should be returned.
projectId path string true The project ID
modelId path string true The model ID

Enumerated Values

Parameter Value
source training
source validation
source holdout
includeIcePlots false
includeIcePlots False
includeIcePlots true
includeIcePlots True

Example responses

200 Response

{
  "featureFit": [
    {
      "featureImportanceScore": 0,
      "featureName": "string",
      "featureType": "string",
      "isBinnable": true,
      "isScalable": true,
      "partialDependence": {
        "data": [
          {
            "dependence": 0,
            "label": "string"
          }
        ],
        "isCapped": true
      },
      "predictedVsActual": {
        "data": [
          {
            "actual": 0,
            "bin": [
              "string"
            ],
            "label": "string",
            "predicted": 0,
            "rowCount": 0
          }
        ],
        "isCapped": true,
        "logScaledData": [
          {
            "actual": 0,
            "bin": [
              "string"
            ],
            "label": "string",
            "predicted": 0,
            "rowCount": 0
          }
        ]
      },
      "weightLabel": "string"
    }
  ],
  "modelId": "string",
  "projectId": "string",
  "source": "string"
}

Responses

Status Meaning Description Schema
200 OK none FeatureFitResponse
403 Forbidden User does not have permission to view the project. None
404 Not Found Project, model, source or computation results do not exist. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/models/{modelId}/featureFit/

NOTE: Starting from API v2.29 this endpoint will be deprecated. Add a request to the queue to calculate Feature Fit. If the job has been previously submitted, the request fails, returning the jobId of the previously submitted job. Use this jobId to check status of the previously submitted job.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/featureFit/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Responses

Status Meaning Description Schema
202 Accepted The Feature Effects request has been successfully submitted. See Location header. None
403 Forbidden User does not have permission to view or submit jobs for the project. None
404 Not Found Provided project or model does not exist. None
422 Unprocessable Entity Queue submission error. None

Response Headers

Status Header Type Format Description
202 Location string A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/featureFitMetadata/

NOTE: Starting from API v2.29 this endpoint will be deprecated. Retrieve Feature Fit metadata. Response contains status and available sources. One of the provided source parameters used for retrieving Feature Fit. * Source can be, at a minimum, training or validation. If holdout is configured for the project, source also includes holdout. * Source value of training is always available.(versions prior to v2.17 support validation only) * When a model is trained into validation or holdout without stacked predictions (i.e., no out-of-sample predictions in validation or holdout), validation and holdout sources are not available.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/featureFitMetadata/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "sources": [
    "training"
  ],
  "status": "INPROGRESS"
}

Responses

Status Meaning Description Schema
200 OK none ModelXrayMetadataResponse
403 Forbidden User does not have permission to view the project. None
404 Not Found Project or model does not exist. None
422 Unprocessable Entity The model is datetime partitioned. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/featureImpact/

Retrieve feature impact scores for features in a model. Feature Impact is computed for each column by creating new data with that column randomly permuted (but the others left unchanged), and seeing how the error metric score for the predictions is affected. Elsewhere this technique is sometimes called 'Permutation Importance'. The impactUnnormalized is how much worse the error metric score is when making predictions on this modified data. The impactNormalized is normalized so that the largest value is 1. In both cases, larger values indicate more important features. If a feature is a redundant feature, i.e. once other features are considered it doesn't contribute much in addition, the redundantWith value is the name of feature that has the highest correlation with this feature.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/featureImpact/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
backtest query any false The backtest value used for Feature Impact computation. Applicable for datetime aware models.
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "backtest": 19,
  "count": 0,
  "featureImpacts": [
    {
      "featureName": "string",
      "impactNormalized": 1,
      "impactUnnormalized": 0,
      "redundantWith": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "ranRedundancyDetection": true,
  "rowCount": 0,
  "shapBased": true
}

Responses

Status Meaning Description Schema
200 OK none PermutationFeatureImpactResponse
404 Not Found No feature impact data found for the given model. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/models/{modelId}/featureImpact/

Add a request to calculate feature impact to the queue. If the job has been previously submitted, the request will fail and return the jobId of previously submitted job. This jobId can be used to check status of previously submitted job.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/featureImpact/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "backtest": 19,
  "rowCount": 10
}

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
body body PermutationFeatureImpactCreatePayload false none

Responses

Status Meaning Description Schema
202 Accepted The request was accepted and will be worked on. None
404 Not Found If modelId does not exist in project leaderboard None
422 Unprocessable Entity If feature impact has already run will return error including jobId property which is the jobId of the previously started feature impact job.

.. minversion:: v2.21

If the rowCount exceeds the maximum or minimum value for this dataset. Minimum is 10 rows. Maximum is 100000 rows or the training sample size of the model, whichever is less.|None|

Response Headers

Status Header Type Format Description
202 Location string A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/featureLists/{datasetId}/clusterInsights/

Retrieve computed Cluster Insights for a clustering project model on a single featurelist.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/featureLists/{datasetId}/clusterInsights/?limit=15 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer false Number of results to skip.
limit query integer true At most this many results are returned. The default may change without notice.
orderBy query string false Order results by the specified field value.
searchFor query string false Search for a specific string in a feature name.This search is case insensitive. If not specified, all features will be returned.
projectId path string true The project ID
modelId path string true The model ID
datasetId path string true The dataset ID

Enumerated Values

Parameter Value
orderBy featureImpact
orderBy -featureImpact
orderBy featureName
orderBy -featureName

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "featureImpact": 0,
      "featureName": "string",
      "featureType": "image",
      "insights": [
        {
          "allData": {
            "images": [
              "string"
            ],
            "percentageOfMissingImages": 100
          },
          "insightName": "representativeImages",
          "perCluster": [
            {
              "clusterName": "string",
              "images": [
                "string"
              ],
              "percentageOfMissingImages": 100
            }
          ]
        }
      ]
    }
  ],
  "isCurrentClusterInsightVersion": true,
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0,
  "version": 0
}

Responses

Status Meaning Description Schema
200 OK Insights for a clustering project model on a single featurelist. ClusterInsightsPaginatedResponse
404 Not Found The project or the model was not found or insights have not been computed yet. None
422 Unprocessable Entity Feature Impact is required. Please, compute it first. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/labelwiseRocCurves/{source}/

Retrieve labelwise ROC curves for model and given source.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/labelwiseRocCurves/{source}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
labels query string false Labels for which data is requested.
searchQuery query string false Search query for label.
sortBy query string false Property to sort labels in the response.
sortOrder query string false Sort order.
threshold query number false Threshold at which the metric should be sorted.
offset query integer false Number of labels to skip.
limit query integer false Number of labels to return.
includeModelAverage query boolean false Whether model average metrics should be included in the response.
projectId path string true Project Id.
modelId path string true Model Id.
source path string true Chart source.

Enumerated Values

Parameter Value
sortBy accuracy
sortBy f1Score
sortBy falsePositiveRate
sortBy label
sortBy matthewsCorrelationCoefficient
sortBy negativePredictiveValue
sortBy positivePredictiveValue
sortBy trueNegativeRate
sortBy truePositiveRate
sortOrder ascending
sortOrder descending
source validation
source crossValidation
source holdout

Example responses

200 Response

{
  "averageModelMetrics": {
    "metrics": [
      {
        "name": "f1Score",
        "numLabelsUsedInCalculation": 0,
        "values": [
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0
        ]
      },
      {
        "name": "f1Score",
        "numLabelsUsedInCalculation": 0,
        "values": [
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0
        ]
      },
      {
        "name": "f1Score",
        "numLabelsUsedInCalculation": 0,
        "values": [
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0
        ]
      },
      {
        "name": "f1Score",
        "numLabelsUsedInCalculation": 0,
        "values": [
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0
        ]
      },
      {
        "name": "f1Score",
        "numLabelsUsedInCalculation": 0,
        "values": [
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0
        ]
      },
      {
        "name": "f1Score",
        "numLabelsUsedInCalculation": 0,
        "values": [
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0
        ]
      },
      {
        "name": "f1Score",
        "numLabelsUsedInCalculation": 0,
        "values": [
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0
        ]
      },
      {
        "name": "f1Score",
        "numLabelsUsedInCalculation": 0,
        "values": [
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0
        ]
      }
    ],
    "source": "validation",
    "thresholds": [
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1,
      1
    ]
  },
  "charts": [
    {
      "auc": 0,
      "kolmogorovSmirnovMetric": 0,
      "label": "string",
      "negativeClassPredictions": [
        0
      ],
      "positiveClassPredictions": [
        0
      ],
      "rocPoints": [
        {
          "accuracy": 1,
          "f1Score": 1,
          "falseNegativeScore": 0,
          "falsePositiveRate": 1,
          "falsePositiveScore": 0,
          "fractionPredictedAsNegative": 0,
          "fractionPredictedAsPositive": 0,
          "liftNegative": 0,
          "liftPositive": 0,
          "matthewsCorrelationCoefficient": -1,
          "negativePredictiveValue": 1,
          "positivePredictiveValue": 1,
          "threshold": 2,
          "trueNegativeRate": 1,
          "trueNegativeScore": 0,
          "truePositiveRate": 1,
          "truePositiveScore": 0
        }
      ],
      "source": "validation"
    }
  ],
  "count": 0,
  "labels": [
    "string"
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "rocType": "binary",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Labelwise ROC curves for model and given source. LabelwiseROC

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/liftChart/

Retrieve all available lift charts for model. The response will include a json list of all available lift charts, in the same format as the response from GET /api/v2/projects/{projectId}/models/{modelId}/liftChart/{source}/.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/liftChart/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "charts": [
    {
      "bins": [
        {
          "actual": 0,
          "binWeight": 0,
          "predicted": 0
        }
      ],
      "source": "backtest_6"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK A list of all of the available lift charts for a model. ModelLiftChartListResponse
403 Forbidden Invalid Permissions None
404 Not Found Please use multiclass lift route for per-class lift data. None
422 Unprocessable Entity Lift chart is not available for unsupervised mode projects. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/liftChart/{source}/

Retrieve the lift chart data from a single source.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/liftChart/{source}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
source path string true Source of the data

Enumerated Values

Parameter Value
source backtest_6
source backtest_7
source backtest_11
source backtest_10
source backtest_8
source backtest_12
source backtest_4
source backtest_13
source backtest_3
source validation
source backtest_20
source backtest_19
source backtest_17
source backtest_9
source crossValidation
source backtest_18
source backtest_2
source backtest_15
source backtest_5
source backtest_14
source backtest_16
source holdout

Example responses

200 Response

{
  "bins": [
    {
      "actual": 0,
      "binWeight": 0,
      "predicted": 0
    }
  ],
  "source": "backtest_6"
}

Responses

Status Meaning Description Schema
200 OK Lift chart data from a single source. ModelLiftChartResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/multiclassFeatureEffects/

Retrieve feature effects for each class in a multiclass model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/multiclassFeatureEffects/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
source query string false Models data source.
includeIcePlots query string false Indicates whether Individual Conditional Expectation (ICE) plots should be returned.
offset query integer false Number of results to skip.
limit query integer false At most this many results are returned. The default may change without notice.
class query string false Target class label.
projectId path string true The project ID
modelId path string true The model ID

Enumerated Values

Parameter Value
source training
source validation
source holdout
includeIcePlots false
includeIcePlots False
includeIcePlots true
includeIcePlots True

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "class": "string",
      "featureImpactScore": 0,
      "featureName": "string",
      "featureType": "string",
      "isBinnable": true,
      "isScalable": true,
      "partialDependence": {
        "data": [
          {
            "dependence": 0,
            "label": "string"
          }
        ],
        "isCapped": true
      },
      "predictedVsActual": {
        "data": [
          {
            "actual": 0,
            "bin": [
              "string"
            ],
            "label": "string",
            "predicted": 0,
            "rowCount": 0
          }
        ],
        "isCapped": true,
        "logScaledData": [
          {
            "actual": 0,
            "bin": [
              "string"
            ],
            "label": "string",
            "predicted": 0,
            "rowCount": 0
          }
        ]
      },
      "weightLabel": "string"
    }
  ],
  "modelId": "string",
  "next": "http://example.com",
  "previous": "http://example.com",
  "projectId": "string",
  "source": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none MulticlassFeatureEffectsResponse
403 Forbidden User does not have permission to view the project. None
404 Not Found Project, model, source or computation results do not exist. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/models/{modelId}/multiclassFeatureEffects/

Compute feature effects for a multiclass model. If the job has been previously submitted, the request fails, returning the jobId of the previously submitted job. Use this jobId to check status of the previously submitted job. NOTE: feature effects are computed for top 100 classes.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/multiclassFeatureEffects/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "features": [
    "string"
  ],
  "rowCount": 10,
  "topNFeatures": 0
}

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
body body MulticlassFeatureEffectCreate false none

Responses

Status Meaning Description Schema
202 Accepted The Feature Effects request has been successfully submitted. See Location header. None
403 Forbidden User does not have permission to view or submit jobs for the project. None
404 Not Found Project, model, source or computation results do not exist. None
422 Unprocessable Entity Queue submission error. If the rowCount exceeds the maximum or minimum value for this dataset. Minimum is 10 rows. Maximum is 100000 rows or the training sample size of the model, whichever is less. If neither features nor topNFeatures is provided. None

Response Headers

Status Header Type Format Description
202 Location string A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/multiclassFeatureImpact/

Retrieve feature impact scores for each class in a multiclass model. Feature Impact is computed for each column by creating new data with that column randomly permuted (but the others left unchanged), and seeing how the error metric score for the predictions is affected. Elsewhere this technique is sometimes called 'Permutation Importance'. The impactUnnormalized is how much worse the error metric score is when making predictions on this modified data. The impactNormalized is normalized so that the largest value is 1. In both cases, larger values indicate more important features.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/multiclassFeatureImpact/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "classFeatureImpacts": [
    {
      "class": "string",
      "featureImpacts": [
        {
          "featureName": "string",
          "impactNormalized": 1,
          "impactUnnormalized": 0,
          "redundantWith": "string"
        }
      ]
    }
  ],
  "ranRedundancyDetection": true,
  "shapBased": true
}

Responses

Status Meaning Description Schema
200 OK none MulticlassFeatureImpactResponse
404 Not Found If no feature impact data found for a given model. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/multiclassLiftChart/

Retrieve all available lift charts for multiclass model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/multiclassLiftChart/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "charts": [
    {
      "classBins": [
        {
          "bins": [
            {
              "actual": 0,
              "binWeight": 0,
              "predicted": 0
            }
          ],
          "targetClass": "string"
        }
      ],
      "source": "validation"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Multiclass lift chart data. AllMulticlassModelLiftChartsResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/multiclassLiftChart/{source}/

Retrieve the multiclass lift chart data from a single source.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/multiclassLiftChart/{source}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
source path string true Source of the data.

Enumerated Values

Parameter Value
source validation
source crossValidation
source holdout

Example responses

200 Response

{
  "classBins": [
    {
      "bins": [
        {
          "actual": 0,
          "binWeight": 0,
          "predicted": 0
        }
      ],
      "targetClass": "string"
    }
  ],
  "source": "validation"
}

Responses

Status Meaning Description Schema
200 OK Multiclass lift chart data from a single source. MulticlassModelLiftChartResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/multilabelLiftCharts/{source}/

Retrieve labelwise lift charts for model and given source.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/multilabelLiftCharts/{source}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
labels query string false Labels for which data is requested.
projectId path string true Project Id.
modelId path string true Model Id.
source path string true Chart source.

Enumerated Values

Parameter Value
source validation
source crossValidation
source holdout

Example responses

200 Response

{
  "labelBins": [
    {
      "bins": [
        {
          "actual": 0,
          "binWeight": 0,
          "predicted": 0
        }
      ],
      "label": "string"
    }
  ],
  "labels": [
    "string"
  ],
  "modelId": "string",
  "projectId": "string",
  "source": "validation"
}

Responses

Status Meaning Description Schema
200 OK Labelwise lift charts for model and given source. LabelwiseLiftChart

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/projects/{projectId}/models/{modelId}/predictionExplanationsInitialization/

Delete an existing PredictionExplanationsInitialization.

Code samples

# You can also use wget
curl -X DELETE http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/predictionExplanationsInitialization/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Responses

Status Meaning Description Schema
204 No Content The deletion was successful. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/predictionExplanationsInitialization/

Retrieve the current PredictionExplanationsInitialization. A PredictionExplanationsInitialization is a pre-requisite for successfully computing prediction explanations using a particular model, and can be used to preview the prediction explanations that would be generated for a complete dataset.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/predictionExplanationsInitialization/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "modelId": "string",
  "predictionExplanationsSample": [
    {
      "adjustedPrediction": 0,
      "adjustedPredictionValues": [
        {
          "label": "string",
          "value": 0
        }
      ],
      "forecastDistance": 0,
      "forecastPoint": "string",
      "prediction": 0,
      "predictionExplanations": [
        {
          "feature": "string",
          "featureValue": "string",
          "imageExplanationUrl": "string",
          "label": "string",
          "perNgramTextExplanations": [
            {
              "isUnknown": true,
              "ngrams": [
                {
                  "label": "string",
                  "value": 0
                }
              ],
              "qualitativateStrength": "string",
              "strength": 0
            }
          ],
          "qualitativateStrength": "string",
          "strength": 0
        }
      ],
      "predictionThreshold": 0,
      "predictionValues": [
        {
          "label": "string",
          "value": 0
        }
      ],
      "rowId": 0,
      "seriesId": "string",
      "timestamp": "string"
    }
  ],
  "projectId": "string"
}

Parameters

Name In Type Required Description
excludeAdjustedPredictions query string false Whether to include adjusted prediction in the PredictionExplanationsSample response.
projectId path string true The project ID
modelId path string true The model ID
body body PredictionExplanationsInitializationRetrieve false none

Enumerated Values

Parameter Value
excludeAdjustedPredictions false
excludeAdjustedPredictions False
excludeAdjustedPredictions true
excludeAdjustedPredictions True

Responses

Status Meaning Description Schema
200 OK none None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/models/{modelId}/predictionExplanationsInitialization/

Create a new prediction explanations initialization. This is a necessary prerequisite for generating prediction explanations.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/predictionExplanationsInitialization/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "maxExplanations": 3,
  "thresholdHigh": null,
  "thresholdLow": null
}

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
body body PredictionExplanationsInitializationCreate false none

Responses

Status Meaning Description Schema
202 Accepted The request was accepted and will be worked on. None

Response Headers

Status Header Type Format Description
202 Location string A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/residuals/

Retrieve all residuals charts for a model.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/residuals/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "residuals": {
    "crossValidation": {
      "coefficientOfDetermination": 0,
      "data": [
        [
          0
        ]
      ],
      "histogram": [
        {
          "intervalEnd": 0,
          "intervalStart": 0,
          "occurrences": 0
        }
      ],
      "residualMean": 0,
      "standardDeviation": 0
    },
    "holdout": {
      "coefficientOfDetermination": 0,
      "data": [
        [
          0
        ]
      ],
      "histogram": [
        {
          "intervalEnd": 0,
          "intervalStart": 0,
          "occurrences": 0
        }
      ],
      "residualMean": 0,
      "standardDeviation": 0
    },
    "validation": {
      "coefficientOfDetermination": 0,
      "data": [
        [
          0
        ]
      ],
      "histogram": [
        {
          "intervalEnd": 0,
          "intervalStart": 0,
          "occurrences": 0
        }
      ],
      "residualMean": 0,
      "standardDeviation": 0
    }
  }
}

Responses

Status Meaning Description Schema
200 OK none ModelResidualsList

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/residuals/{source}/

Retrieve the residuals chart data from a single source.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/residuals/{source}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
source path string true Source of the data.

Enumerated Values

Parameter Value
source validation
source crossValidation
source holdout

Example responses

200 Response

{
  "residuals": {
    "crossValidation": {
      "coefficientOfDetermination": 0,
      "data": [
        [
          0
        ]
      ],
      "histogram": [
        {
          "intervalEnd": 0,
          "intervalStart": 0,
          "occurrences": 0
        }
      ],
      "residualMean": 0,
      "standardDeviation": 0
    },
    "holdout": {
      "coefficientOfDetermination": 0,
      "data": [
        [
          0
        ]
      ],
      "histogram": [
        {
          "intervalEnd": 0,
          "intervalStart": 0,
          "occurrences": 0
        }
      ],
      "residualMean": 0,
      "standardDeviation": 0
    },
    "validation": {
      "coefficientOfDetermination": 0,
      "data": [
        [
          0
        ]
      ],
      "histogram": [
        {
          "intervalEnd": 0,
          "intervalStart": 0,
          "occurrences": 0
        }
      ],
      "residualMean": 0,
      "standardDeviation": 0
    }
  }
}

Responses

Status Meaning Description Schema
200 OK none ModelResidualsList

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/rocCurve/

Retrieve all available ROC curves for model. The response will include a json list of all available ROC curves, in the same format as the response from GET /api/v2/projects/{projectId}/models/{modelId}/rocCurve/{source}/.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/rocCurve/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "charts": [
    {
      "auc": 0,
      "kolmogorovSmirnovMetric": 0,
      "negativeClassPredictions": [
        0
      ],
      "positiveClassPredictions": [
        0
      ],
      "rocPoints": [
        {
          "accuracy": 0,
          "f1Score": 0,
          "falseNegativeScore": 0,
          "falsePositiveRate": 0,
          "falsePositiveScore": 0,
          "fractionPredictedAsNegative": 0,
          "fractionPredictedAsPositive": 0,
          "liftNegative": 0,
          "liftPositive": 0,
          "matthewsCorrelationCoefficient": 0,
          "negativePredictiveValue": 0,
          "positivePredictiveValue": 0,
          "threshold": 0,
          "trueNegativeRate": 0,
          "trueNegativeScore": 0,
          "truePositiveRate": 0,
          "truePositiveScore": 0
        }
      ],
      "source": "backtest_6"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK A list of all of the available ROC curves for a model. ModelRocCurveListResponse
403 Forbidden Invalid Permissions None
404 Not Found This resource does not exist. None
422 Unprocessable Entity Unsupervised mode projects do not have ROC curves None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/rocCurve/{source}/

Retrieve the ROC curve data from a single source. The response includes an array of pointsshowing the performance of the model at different thresholds for classification, and arrays of sample predictions for both the positive and negative classes.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/rocCurve/{source}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
source path string true Source of the data

Enumerated Values

Parameter Value
source backtest_6
source backtest_7
source backtest_11
source backtest_10
source backtest_8
source backtest_12
source backtest_4
source backtest_13
source backtest_3
source validation
source backtest_20
source backtest_19
source backtest_17
source backtest_9
source crossValidation
source backtest_18
source backtest_2
source backtest_15
source backtest_5
source backtest_14
source backtest_16
source holdout

Example responses

200 Response

{
  "auc": 0,
  "kolmogorovSmirnovMetric": 0,
  "negativeClassPredictions": [
    0
  ],
  "positiveClassPredictions": [
    0
  ],
  "rocPoints": [
    {
      "accuracy": 0,
      "f1Score": 0,
      "falseNegativeScore": 0,
      "falsePositiveRate": 0,
      "falsePositiveScore": 0,
      "fractionPredictedAsNegative": 0,
      "fractionPredictedAsPositive": 0,
      "liftNegative": 0,
      "liftPositive": 0,
      "matthewsCorrelationCoefficient": 0,
      "negativePredictiveValue": 0,
      "positivePredictiveValue": 0,
      "threshold": 0,
      "trueNegativeRate": 0,
      "trueNegativeScore": 0,
      "truePositiveRate": 0,
      "truePositiveScore": 0
    }
  ],
  "source": "backtest_6"
}

Responses

Status Meaning Description Schema
200 OK ROC curve data from a single source. ModelRocCurveResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/shapImpact/

Retrieve Feature Impact for a model. Shap impact is computed by calculating the shap values on a sample of training data and then taking the mean absolute value for each column. The larger value of impact indicate more important feature.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/shapImpact/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID

Example responses

200 Response

{
  "count": 0,
  "rowCount": 0,
  "shapImpacts": [
    {
      "featureName": "string",
      "impactNormalized": 0,
      "impactUnnormalized": 0
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Retrieve Feature Impact for a model. ShapImpactRetrieveResponse
404 Not Found Feature Impact was not found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/models/{modelId}/shapImpact/

Create a Shap based Feature Impact with a model.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/shapImpact/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "rowCount": 10
}

Parameters

Name In Type Required Description
projectId path string true The project ID
modelId path string true The model ID
body body FeatureImpactCreatePayload false none

Responses

Status Meaning Description Schema
200 OK none None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/wordCloud/

Retrieve word cloud data for a model. Not all models will have word cloud data available, even when they use text features.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/models/{modelId}/wordCloud/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
excludeStopWords query string false Set to true if you want stopwords excluded from the response.
projectId path string true The project ID
modelId path string true The model ID

Enumerated Values

Parameter Value
excludeStopWords false
excludeStopWords False
excludeStopWords true
excludeStopWords True

Example responses

200 Response

{
  "ngrams": [
    {
      "class": "string",
      "coefficient": -1,
      "count": 0,
      "frequency": 0,
      "isStopword": true,
      "ngram": "string",
      "variable": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none WordCloudRetrieveResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/multicategoricalInvalidFormat/

Retrieve multicategorical data quality log.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/multicategoricalInvalidFormat/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The ID of the project this request is associated with.

Example responses

200 Response

{
  "data": {
    "errors": [
      {
        "error": "string",
        "feature": "string",
        "rowData": "string",
        "rowIndex": 0
      }
    ]
  },
  "projectId": "string"
}

Responses

Status Meaning Description Schema
200 OK Data quality log for multicategorical features. MulticategoricalInvalidFormatResponse
422 Unprocessable Entity Not a data quality enabled project None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/multicategoricalInvalidFormat/file/

Get file with format errors of potential multicategorical features.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/multicategoricalInvalidFormat/file/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The ID of the project this request is associated with.

Responses

Status Meaning Description Schema
200 OK File with format errors of potential multicategorical features. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/payoffMatrices/

List of all payoff matrices for a project.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/projects/{projectId}/payoffMatrices/?offset=0&limit=100 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true Number of payoff matrices to skip.
limit query integer true Number of payoff matrices to return.
projectId path string true The project ID

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "falseNegativeValue": 0,
      "falsePositiveValue": 0,
      "id": "string",
      "name": "string",
      "projectId": "string",
      "trueNegativeValue": 0,
      "truePositiveValue": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK List of payoff matrices. PayoffMatricesListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/payoffMatrices/

Create a payoff matrix associated with a project.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/projects/{projectId}/payoffMatrices/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "falseNegativeValue": 0,
  "falsePositiveValue": 0,
  "name": "string",
  "trueNegativeValue": 0,
  "truePositiveValue": 0
}

Parameters

Name In Type Required Description
projectId path string true The project ID
body body PayoffMatricesCreate false none

Responses

Status Meaning Description Schema
200 OK none None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/projects/{projectId}/payoffMatrices/{payoffMatrixId}/

Delete a payoff matrix in a project.

Code samples

# You can also use wget
curl -X DELETE http://10.97.111.38/api/v2/projects/{projectId}/payoffMatrices/{payoffMatrixId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
projectId path string true The project ID
payoffMatrixId path string true ObjectId of the payoff matrix.

Responses

Status Meaning Description Schema
204 No Content Payoff matrix deleted successfully. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PUT /api/v2/projects/{projectId}/payoffMatrices/{payoffMatrixId}/

Update all fields in a payoff matrix, including values and label.

Code samples

# You can also use wget
curl -X PUT http://10.97.111.38/api/v2/projects/{projectId}/payoffMatrices/{payoffMatrixId}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "falseNegativeValue": 0,
  "falsePositiveValue": 0,
  "name": "string",
  "trueNegativeValue": 0,
  "truePositiveValue": 0
}

Parameters

Name In Type Required Description
projectId path string true The project ID
payoffMatrixId path string true ObjectId of the payoff matrix.
body body PayoffMatricesCreate false none

Example responses

200 Response

{
  "falseNegativeValue": 0,
  "falsePositiveValue": 0,
  "id": "string",
  "name": "string",
  "projectId": "string",
  "trueNegativeValue": 0,
  "truePositiveValue": 0
}

Responses

Status Meaning Description Schema
200 OK Updated payoff matrix values and label. PayoffMatricesResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/predictionExplanations/

Create a new PredictionExplanations object (and its accompanying PredictionExplana