Skip to content

On-premise users: click in-app to access the full platform documentation for your version of DataRobot.

DataRobot API resources > API reference documentation > DataRobot REST API > Monitoring > Data exports

Observability Data Exploration

This page outlines the operations, endpoints, parameters, and example requests and responses for the Observability Data Exploration.

GET /api/v2/deployments/{deploymentId}/actualsDataExports/

Retrieve a list of asynchronous actuals data exports.

Code samples

curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/actualsDataExports/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false Offset this number of objects to retrieve.
limit query integer false At most this number of objects to retrieve.
status query string,null false An actuals data export state overwrite value.
deploymentId path string true Unique identifier of the deployment.

Enumerated Values

Parameter Value
status [CANCELLED, CREATED, FAILED, SCHEDULED, SUCCEEDED, null]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": {
        "id": "string"
      },
      "data": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "error": {
        "message": "string"
      },
      "id": "string",
      "modelId": "string",
      "onlyMatchedPredictions": true,
      "period": {
        "end": "2019-08-24T14:15:22Z",
        "start": "2019-08-24T14:15:22Z"
      },
      "status": "CANCELLED"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Success ActualsExportListResponse
403 Forbidden User does not have permission to access a particular deployment. None
404 Not Found Resource not found. None
422 Unprocessable Entity Unable to process the actuals data exports list retrieval due to invalid parameter values. None

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

BearerAuth

POST /api/v2/deployments/{deploymentId}/actualsDataExports/

Create a deployment actuals data export.

Code samples

curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/actualsDataExports/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "end": "2019-08-24T14:15:22Z",
  "modelId": "string",
  "onlyMatchedPredictions": true,
  "start": "2019-08-24T14:15:22Z"
}

Parameters

Name In Type Required Description
deploymentId path string true Unique identifier of the deployment.
body body ActualsExportCreatePayload false none

Example responses

202 Response

{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string"
  },
  "data": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "error": {
    "message": "string"
  },
  "id": "string",
  "modelId": "string",
  "onlyMatchedPredictions": true,
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  },
  "status": "CANCELLED"
}

Responses

Status Meaning Description Schema
202 Accepted Actuals data export successfully created. ActualsDataExportEntity
403 Forbidden User does not have permission to create an actuals data export. None
404 Not Found Resource not found. None
422 Unprocessable Entity Unable to process the actuals data export creation request. None

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

BearerAuth

DELETE /api/v2/deployments/{deploymentId}/actualsDataExports/{exportId}/

Delete an actual export.

Code samples

curl -X DELETE https://app.datarobot.com/api/v2/deployments/{deploymentId}/actualsDataExports/{exportId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
deploymentId path string true ID of the deployment.
exportId path string true ID of the actuals data export job.

Responses

Status Meaning Description Schema
204 No Content An actual export was successfully deleted. None
403 Forbidden User does not have permission to delete an actual export. None
404 Not Found Actual export was not found. None

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

BearerAuth

GET /api/v2/deployments/{deploymentId}/actualsDataExports/{exportId}/

Retrieve a single actuals data export.

Code samples

curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/actualsDataExports/{exportId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
deploymentId path string true ID of the deployment.
exportId path string true ID of the actuals data export job.

Example responses

200 Response

{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string"
  },
  "data": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "error": {
    "message": "string"
  },
  "id": "string",
  "modelId": "string",
  "onlyMatchedPredictions": true,
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  },
  "status": "CANCELLED"
}

Responses

Status Meaning Description Schema
200 OK A given actuals data export user can view is retrieved. ActualsDataExportEntity
403 Forbidden User does not have permission to access a particular deployment or actuals data export. None
404 Not Found Resource not found. None

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

BearerAuth

PATCH /api/v2/deployments/{deploymentId}/actualsDataExports/{exportId}/

Update actuals data export.

Code samples

curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/actualsDataExports/{exportId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "status": "CANCELLED"
}

Parameters

Name In Type Required Description
deploymentId path string true ID of the deployment.
exportId path string true ID of the actuals data export job.
body body ActualsDataUpdate false none

Example responses

204 Response

{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string"
  },
  "data": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "error": {
    "message": "string"
  },
  "id": "string",
  "modelId": "string",
  "onlyMatchedPredictions": true,
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  },
  "status": "CANCELLED"
}

Responses

Status Meaning Description Schema
204 No Content Actuals data export updated. ActualsDataExportEntity
403 Forbidden User does not have permission to update the actuals data export. None
404 Not Found Requested resource does not exist or the user does not have permission to view it. None
422 Unprocessable Entity Unable to process the actuals data export update. None

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

BearerAuth

GET /api/v2/deployments/{deploymentId}/dataQualityView/

Retrieve metadata of the data to be exported.

Code samples

curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/dataQualityView/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false Specifies the number of rows to skip before starting to return rows from the query.
limit query integer false Specifies the number of rows to return after the offset.
start query string(date-time) false Start of the period of prediction data to collect. Defaults to a week before the end time.
end query string(date-time) false End of the period of prediction data to collect. Defaults to now, or a week after the start time.
modelId query string false The ID of the model.
predictionPattern query string,null false The keywords to search in a predicted value, for text generation target types.
promptPattern query string,null false The keywords to search in a prompt value, for text generation target types.
actualPattern query string,null false The keywords to search in an actual value, for text generation target types.
orderBy query string,null false Field by which to order the text generation target types.
orderMetric query string,null false Metric name or ID used for metric ordering.
filterMetric query string,null false Metric name or ID used for metric filtering.
filterValue query string,null false Metric value required to match value with filter metric name.
deploymentId path string true Unique identifier of the deployment.

Enumerated Values

Parameter Value
orderBy [timestamp, associationId, customMetrics, -timestamp, -associationId, -customMetrics]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "actualValue": "string",
      "associationId": "string",
      "context": [
        {
          "context": "string",
          "link": "string"
        }
      ],
      "metrics": [
        {
          "id": "string",
          "metadata": null,
          "name": "string",
          "value": 0
        }
      ],
      "predictedValue": "string",
      "prompt": "string",
      "timestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none DataQualityResponse

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

BearerAuth

GET /api/v2/deployments/{deploymentId}/predictionDataExports/

A list of asynchronous prediction data exports.

Code samples

curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/predictionDataExports/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false Specifies the number of rows to skip before starting to return rows from the query.
limit query integer false Specifies the number of rows to return after the offset.
status query string,null false A prediction data export processing state.
modelId query string,null false Id of model used for prediction data export.
batch query string false If true, returns just the exports associated with batches. If false, just the real-time ones. If not provided, returns both real-time and batch exports.
deploymentId path string true Unique identifier of the deployment.

Enumerated Values

Parameter Value
status [CANCELLED, CREATED, FAILED, SCHEDULED, SUCCEEDED, null]
batch [false, False, true, True]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "associationIds": [
        "string"
      ],
      "augmentationType": "NO_AUGMENTATION",
      "batches": [
        {
          "batchId": "string",
          "batchName": "string"
        }
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "data": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "error": {
        "message": "string"
      },
      "id": "string",
      "modelId": "string",
      "period": {
        "end": "2019-08-24T14:15:22Z",
        "start": "2019-08-24T14:15:22Z"
      },
      "status": "CANCELLED"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK The prediction data exports. PredictionExportListResponse
403 Forbidden User does not have permission to access a particular deployment. None
404 Not Found Resource not found. None
422 Unprocessable Entity Unable to process the prediction data exports list retrieval due to invalid parameter values. None

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

BearerAuth

POST /api/v2/deployments/{deploymentId}/predictionDataExports/

Create a deployment prediction data export.

Code samples

curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/predictionDataExports/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "augmentationType": "NO_AUGMENTATION",
  "batchIds": [
    "string"
  ],
  "end": "2019-08-24T14:15:22Z",
  "modelId": "string",
  "start": "2019-08-24T14:15:22Z"
}

Parameters

Name In Type Required Description
deploymentId path string true Unique identifier of the deployment.
body body ExportCreatePayload false none

Example responses

202 Response

{
  "associationIds": [
    "string"
  ],
  "augmentationType": "NO_AUGMENTATION",
  "batches": [
    {
      "batchId": "string",
      "batchName": "string"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "data": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "error": {
    "message": "string"
  },
  "id": "string",
  "modelId": "string",
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  },
  "status": "CANCELLED"
}

Responses

Status Meaning Description Schema
202 Accepted Prediction data export successfully created. ExportEntity
403 Forbidden User does not have permission to create a prediction data export. None
404 Not Found Resource not found. None
422 Unprocessable Entity Unable to process the prediction data export creation request. None

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

BearerAuth

GET /api/v2/deployments/{deploymentId}/predictionDataExports/{exportId}/

Retrieve a single prediction data export.

Code samples

curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/predictionDataExports/{exportId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
deploymentId path string true Unique identifier of the deployment.
exportId path string true Unique identifier of the export.

Example responses

200 Response

{
  "associationIds": [
    "string"
  ],
  "augmentationType": "NO_AUGMENTATION",
  "batches": [
    {
      "batchId": "string",
      "batchName": "string"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "data": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "error": {
    "message": "string"
  },
  "id": "string",
  "modelId": "string",
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  },
  "status": "CANCELLED"
}

Responses

Status Meaning Description Schema
200 OK A given prediction data export user can view is retrieved. ExportEntity
403 Forbidden User does not have permission to access a particular deployment or prediction data export. None
404 Not Found Resource not found. None

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

BearerAuth

PATCH /api/v2/deployments/{deploymentId}/predictionDataExports/{exportId}/

Update prediction data export.

Code samples

curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/predictionDataExports/{exportId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "status": "CANCELLED"
}

Parameters

Name In Type Required Description
deploymentId path string true Unique identifier of the deployment.
exportId path string true Unique identifier of the export.
body body PredictionDataUpdate false none

Example responses

204 Response

{
  "associationIds": [
    "string"
  ],
  "augmentationType": "NO_AUGMENTATION",
  "batches": [
    {
      "batchId": "string",
      "batchName": "string"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "data": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "error": {
    "message": "string"
  },
  "id": "string",
  "modelId": "string",
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  },
  "status": "CANCELLED"
}

Responses

Status Meaning Description Schema
204 No Content Prediction data export successfully updated. ExportEntity
403 Forbidden User does not have permission to update a prediction data export. None
404 Not Found Requested resource does not exist or the user does not have permission to view it. None
422 Unprocessable Entity Unable to process the prediction data export update. None

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

BearerAuth

GET /api/v2/deployments/{deploymentId}/predictionResults/

Retrieve predictions results of the deployment.

Code samples

curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/predictionResults/ \
  -H "Accept: application/json" \
  -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 id of the model for which prediction results are being retrieved.
start query string(date-time) false Start of the period for which prediction results are being retrieved.
end query string(date-time) false End of the period for which prediction results are being retrieved.
batchId query any false The id of the batch for which prediction results are being retrieved.
actualsPresent query boolean false Filters predictions results to only those who have actuals present or with missing actuals.
deploymentId path string true Unique identifier of the deployment.
Accept header string false Requested MIME type for the returned data

Enumerated Values

Parameter Value
Accept [application/json, text/csv]

Example responses

200 Response

{
  "associationIdColumnNames": [
    "string"
  ],
  "count": 0,
  "data": [
    {
      "actual": 0,
      "associationId": "string",
      "forecastDistance": 0,
      "modelId": "string",
      "predicted": 0,
      "timestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Responses

Status Meaning Description Schema
200 OK none string

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

BearerAuth

GET /api/v2/deployments/{deploymentId}/trainingDataExports/

A list of successful training data exports.

Code samples

curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/trainingDataExports/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false Specifies the number of rows to skip before starting to return rows from the query.
limit query integer false Specifies the number of rows to return after the offset.
modelId query string,null false Id of model used for training data export.
deploymentId path string true Unique identifier of the deployment.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "data": {
        "id": "string",
        "name": "string"
      },
      "id": "string",
      "modelId": "string",
      "modelPackageId": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK The training data exports. TrainingDataExportListResponse
403 Forbidden User does not have permission to access a particular deployment. None
404 Not Found Resource not found. None
422 Unprocessable Entity Unable to process the training data exports list retrieval due to invalid parameter values. None

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

BearerAuth

POST /api/v2/deployments/{deploymentId}/trainingDataExports/

Create a deployment training data export.

Code samples

curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/trainingDataExports/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "modelId": null
}

Parameters

Name In Type Required Description
deploymentId path string true Unique identifier of the deployment.
body body TrainingDataExportCreatePayload false none

Responses

Status Meaning Description Schema
202 Accepted Training data export successfully enqueued. None
403 Forbidden User does not have permission to create a training data export. None
404 Not Found Resource not found. None
422 Unprocessable Entity Unable to process the training data export request. None

Response Headers

Status Header Type Format Description
202 Location string URL to poll to get status of job that waits for the training data export to finish

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

BearerAuth

GET /api/v2/deployments/{deploymentId}/trainingDataExports/{exportId}/

Retrieve a single training data export details.

Code samples

curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/trainingDataExports/{exportId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
deploymentId path string true Unique identifier of the deployment.
exportId path string true Unique identifier of the export.

Example responses

200 Response

{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "data": {
    "id": "string",
    "name": "string"
  },
  "id": "string",
  "modelId": "string",
  "modelPackageId": "string"
}

Responses

Status Meaning Description Schema
200 OK A given training data export user can view is retrieved. TrainingDataExportEntity
403 Forbidden User does not have permission to access a particular deployment or training data export. None
404 Not Found Resource not found. None

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

BearerAuth

Schemas

ActualsCreatedBy

{
  "id": "string"
}

The user that created actuals data export.

Properties

Name Type Required Restrictions Description
id string true The ID of user who created actuals data export.

ActualsDataEntry

{
  "id": "string",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id string true The ID of an entry.
name string true A name of an entry.

ActualsDataExportEntity

{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string"
  },
  "data": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "error": {
    "message": "string"
  },
  "id": "string",
  "modelId": "string",
  "onlyMatchedPredictions": true,
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  },
  "status": "CANCELLED"
}

Properties

Name Type Required Restrictions Description
createdAt string(date-time) true Actuals data export creation timestamp.
createdBy ActualsCreatedBy true The user that created actuals data export.
data [ActualsDataEntry] false An actuals data export collected data entries. Available only when status is SUCCEEDED.
error ActualsError false Error description. Appears when actuals data export job failed (status is FAILED).
id string true The ID of the actuals data export.
modelId string true The ID of the model (or null if not specified).
onlyMatchedPredictions boolean false If true, exports actuals with matching predictions only.
period ActualsDataTimeRange true An actuals data time range definition.
status string true An actuals data export processing state.

Enumerated Values

Property Value
status [CANCELLED, CREATED, FAILED, SCHEDULED, SUCCEEDED]

ActualsDataTimeRange

{
  "end": "2019-08-24T14:15:22Z",
  "start": "2019-08-24T14:15:22Z"
}

An actuals data time range definition.

Properties

Name Type Required Restrictions Description
end string(date-time) true End of the period of actuals data to collect.
start string(date-time) true Start of the period of actuals data to collect.

ActualsDataUpdate

{
  "status": "CANCELLED"
}

Properties

Name Type Required Restrictions Description
status string false An actuals data export state overwrite value.

Enumerated Values

Property Value
status CANCELLED

ActualsError

{
  "message": "string"
}

Error description. Appears when actuals data export job failed (status is FAILED).

Properties

Name Type Required Restrictions Description
message string true A human readable error message describing failure cause.

ActualsExportCreatePayload

{
  "end": "2019-08-24T14:15:22Z",
  "modelId": "string",
  "onlyMatchedPredictions": true,
  "start": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
end string(date-time) true End of the period of actuals data to collect.
modelId string false The ID of the model.
onlyMatchedPredictions boolean false If true, exports actuals with matching predictions only.
start string(date-time) true Start of the period of actuals data to collect.

ActualsExportListResponse

{
  "count": 0,
  "data": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": {
        "id": "string"
      },
      "data": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "error": {
        "message": "string"
      },
      "id": "string",
      "modelId": "string",
      "onlyMatchedPredictions": true,
      "period": {
        "end": "2019-08-24T14:15:22Z",
        "start": "2019-08-24T14:15:22Z"
      },
      "status": "CANCELLED"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true minimum: 0
 Number of paginated entries.
data [ActualsDataExportEntity] true A list of asynchronous actuals data exports.
next string,null true URL to the next page, or null if there is no such page.
previous string,null true URL to the previous page, or null if there is no such page
totalCount integer true minimum: 0
 Total number of entries.

ContextItem

{
  "context": "string",
  "link": "string"
}

Properties

Name Type Required Restrictions Description
context string true Text generation context.
link string,null false Text generation context link.

DataQualityItem

{
  "actualValue": "string",
  "associationId": "string",
  "context": [
    {
      "context": "string",
      "link": "string"
    }
  ],
  "metrics": [
    {
      "id": "string",
      "metadata": null,
      "name": "string",
      "value": 0
    }
  ],
  "predictedValue": "string",
  "prompt": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
actualValue string,null true Actual value
associationId string true Association ID of prediction.
context [ContextItem] true maxItems: 10
 A list of contexts used for text generation response.
metrics [MetricValue] true maxItems: 100
 A list of collected metrics associated with the prediction instance.
predictedValue string,null true Predicted value
prompt string,null true Prompt for text generation target types.
timestamp string(date-time) true Record creation timestamp.

DataQualityResponse

{
  "count": 0,
  "data": [
    {
      "actualValue": "string",
      "associationId": "string",
      "context": [
        {
          "context": "string",
          "link": "string"
        }
      ],
      "metrics": [
        {
          "id": "string",
          "metadata": null,
          "name": "string",
          "value": 0
        }
      ],
      "predictedValue": "string",
      "prompt": "string",
      "timestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true minimum: 0
 Number of paginated entries.
data [DataQualityItem] true maxItems: 100
 A list of prediction data exports.
next string,null true The URL to the next page, or null if there is no such page.
previous string,null true The URL to the previous page, or null if there is no such page.
totalCount integer true minimum: 0
 The total number of entries.

ExportCreatePayload

{
  "augmentationType": "NO_AUGMENTATION",
  "batchIds": [
    "string"
  ],
  "end": "2019-08-24T14:15:22Z",
  "modelId": "string",
  "start": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
augmentationType string,null false Indicates if prediction data is augmented with actuals or metrics
batchIds [string] false maxItems: 100
minItems: 1
 IDs of batches to export. Null for real-time data exports.
end string(date-time) false End of the period of prediction data to collect. Defaults to now, or a week after the start time.
modelId string false The ID of the model.
start string(date-time) false Start of the period of prediction data to collect. Defaults to a week before the end time.

Enumerated Values

Property Value
augmentationType [NO_AUGMENTATION, ACTUALS_AND_METRICS]

ExportEntity

{
  "associationIds": [
    "string"
  ],
  "augmentationType": "NO_AUGMENTATION",
  "batches": [
    {
      "batchId": "string",
      "batchName": "string"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "data": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "error": {
    "message": "string"
  },
  "id": "string",
  "modelId": "string",
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  },
  "status": "CANCELLED"
}

Properties

Name Type Required Restrictions Description
associationIds [string] false maxItems: 100
minItems: 1
 Association IDs of rows to export
augmentationType string,null false Indicates if prediction data is augmented with actuals or metrics
batches [PredictionDataBatch] false maxItems: 100
minItems: 1
 Metadata associated with exported batch.
createdAt string(date-time) true Prediction data export creation timestamp.
createdBy string true The user that created prediction data export.
data [PredictionDataEntry] false A prediction data export collected data entries. Available only when status is SUCCEEDED.
error ExportError false Error description. Appears when prediction data export job failed (status is FAILED).
id string true The ID of the prediction data export.
modelId string true The ID of the model (or null if not specified).
period PredictionDataTimeRange true A prediction data time range definition.
status string true A prediction data export processing state.

Enumerated Values

Property Value
augmentationType [NO_AUGMENTATION, ACTUALS_AND_METRICS]
status [CANCELLED, CREATED, FAILED, SCHEDULED, SUCCEEDED]

ExportError

{
  "message": "string"
}

Error description. Appears when prediction data export job failed (status is FAILED).

Properties

Name Type Required Restrictions Description
message string true A human readable error message describing failure cause.

MetricValue

{
  "id": "string",
  "metadata": null,
  "name": "string",
  "value": 0
}

Properties

Name Type Required Restrictions Description
id string true The ID of the custom metric.
metadata string,null false Custom metric value metadata.
name string true Custom metric name.
value any true Custom metric value.

oneOf

Name Type Required Restrictions Description
» anonymous number false none

xor

Name Type Required Restrictions Description
» anonymous string false none

PredictionDataBatch

{
  "batchId": "string",
  "batchName": "string"
}

Properties

Name Type Required Restrictions Description
batchId string true An ID of a batch.
batchName string true A name of a batch.

PredictionDataEntry

{
  "id": "string",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
id string true The ID of the AI Catalog entry.
name string true The name of the AI Catalog entry.

PredictionDataTimeRange

{
  "end": "2019-08-24T14:15:22Z",
  "start": "2019-08-24T14:15:22Z"
}

A prediction data time range definition.

Properties

Name Type Required Restrictions Description
end string(date-time) true End of the period of prediction data to collect.
start string(date-time) true Start of the period of prediction data to collect.

PredictionDataUpdate

{
  "status": "CANCELLED"
}

Properties

Name Type Required Restrictions Description
status string false A prediction data export processing state.

Enumerated Values

Property Value
status CANCELLED

PredictionExportListResponse

{
  "count": 0,
  "data": [
    {
      "associationIds": [
        "string"
      ],
      "augmentationType": "NO_AUGMENTATION",
      "batches": [
        {
          "batchId": "string",
          "batchName": "string"
        }
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "data": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "error": {
        "message": "string"
      },
      "id": "string",
      "modelId": "string",
      "period": {
        "end": "2019-08-24T14:15:22Z",
        "start": "2019-08-24T14:15:22Z"
      },
      "status": "CANCELLED"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true minimum: 0
 Number of paginated entries.
data [ExportEntity] true A list of prediction data exports.
next string,null true URL to the next page, or null if there is no such page.
previous string,null true URL to the previous page, or null if there is no such page
totalCount integer true minimum: 0
 Total number of entries.

PredictionResultResponse

{
  "actual": 0,
  "associationId": "string",
  "forecastDistance": 0,
  "modelId": "string",
  "predicted": 0,
  "timestamp": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
actual any true Actual value of the prediction

oneOf

Name Type Required Restrictions Description
» anonymous integer false none

xor

Name Type Required Restrictions Description
» anonymous number false none

xor

Name Type Required Restrictions Description
» anonymous string false none

continued

Name Type Required Restrictions Description
associationId string true Association id of the prediction, which is used to associate a prediction with its actual value and calculate accuracy.
forecastDistance integer,null false The number of time units this prediction is away from the forecastPoint. The unit of time is determined by the timeUnit of the datetime partition column. For time series models only.
modelId string true ID of the model used to make these predictions
predicted any true Predicted value of the prediction

oneOf

Name Type Required Restrictions Description
» anonymous integer false none

xor

Name Type Required Restrictions Description
» anonymous number false none

xor

Name Type Required Restrictions Description
» anonymous string false none

continued

Name Type Required Restrictions Description
timestamp string(date-time) true When the prediction was made.

PredictionResultsListResponse

{
  "associationIdColumnNames": [
    "string"
  ],
  "count": 0,
  "data": [
    {
      "actual": 0,
      "associationId": "string",
      "forecastDistance": 0,
      "modelId": "string",
      "predicted": 0,
      "timestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Properties

Name Type Required Restrictions Description
associationIdColumnNames [string] true List of column names used to represent an association id, which is used to unique identify individual prediction rows.
count integer false Number of items returned on this page.
data [PredictionResultResponse] true An array of prediction requests.
next string,null(uri) true URL pointing to the next page (if null, there is no next page).
previous string,null(uri) true URL pointing to the previous page (if null, there is no previous page).

TrainingDataEntry

{
  "id": "string",
  "name": "string"
}

A training data entry.

Properties

Name Type Required Restrictions Description
id string true The ID of the AI Catalog entry.
name string true The name of the AI Catalog entry.

TrainingDataExportCreatePayload

{
  "modelId": null
}

Properties

Name Type Required Restrictions Description
modelId string,null false (Optional) The ID of the model.

TrainingDataExportEntity

{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "data": {
    "id": "string",
    "name": "string"
  },
  "id": "string",
  "modelId": "string",
  "modelPackageId": "string"
}

Properties

Name Type Required Restrictions Description
createdAt string(date-time) true Training data export creation timestamp.
createdBy string true The user who created training data export.
data TrainingDataEntry true A training data entry.
id string true The ID of the training data export.
modelId string true The ID of the model.
modelPackageId string true The ID of the related model package.

TrainingDataExportListResponse

{
  "count": 0,
  "data": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "data": {
        "id": "string",
        "name": "string"
      },
      "id": "string",
      "modelId": "string",
      "modelPackageId": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true minimum: 0
 Number of paginated entries.
data [TrainingDataExportEntity] true A list of training data exports.
next string,null true URL to the next page, or null if there is no such page.
previous string,null true URL to the previous page, or null if there is no such page
totalCount integer true minimum: 0
 Total number of entries.
Updated March 25, 2025