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 > Batch monitoring

Observability Batch Monitoring

This page outlines the operations, endpoints, parameters, and example requests and responses for the Observability Batch Monitoring.

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

Get the limits related to monitoring batches.

Code samples

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

Parameters

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

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/deployments/{deploymentId}/monitoringBatches/

List monitoring batches in a deployment.

Code samples

curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/monitoringBatches/ \
  -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.
createdBy query string false ID of the user who created a batch.
search query string false Search by matching batch name in a case-insensitive manner or exact match of batch ID.
orderBy query string false Order of the returning batches.
createdAfter query string(date-time) false Filter for batches created after the given time
createdBefore query string(date-time) false Filter for batches created before the given time
startAfter query string(date-time) false Filter for batches with a start time after the given time
endBefore query string(date-time) false Filter for batches with an end time before the given time
deploymentId path string true Unique identifier of the deployment.

Enumerated Values

Parameter Value
orderBy [name, -name, createdAt, -createdAt, earliestPredictionTimestamp, -earliestPredictionTimestamp, latestPredictionTimestamp, -latestPredictionTimestamp]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "batchPredictionJobId": "string",
      "batchPredictionJobStatus": "INITIALIZING",
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": {
        "id": "string",
        "name": "string"
      },
      "description": "string",
      "earliestPredictionTimestamp": "2019-08-24T14:15:22Z",
      "externalContextUrl": "http://example.com",
      "id": "string",
      "isLocked": true,
      "latestPredictionTimestamp": "2019-08-24T14:15:22Z",
      "name": "string",
      "predictionsCount": 0,
      "serviceHealth": {
        "message": "string",
        "status": "string"
      }
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none MonitoringBatchListResponse

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

BearerAuth

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

Create a monitoring batch for a deployment.

Code samples

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

Body parameter

{
  "batchName": "string",
  "description": "string",
  "externalContextUrl": "http://example.com",
  "isLocked": true
}

Parameters

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

Example responses

200 Response

{
  "batchPredictionJobId": "string",
  "batchPredictionJobStatus": "INITIALIZING",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string",
    "name": "string"
  },
  "description": "string",
  "earliestPredictionTimestamp": "2019-08-24T14:15:22Z",
  "externalContextUrl": "http://example.com",
  "id": "string",
  "isLocked": true,
  "latestPredictionTimestamp": "2019-08-24T14:15:22Z",
  "name": "string",
  "predictionsCount": 0,
  "serviceHealth": {
    "message": "string",
    "status": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK none MonitoringBatch

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

BearerAuth

DELETE /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/

Delete a monitoring batch in a deployment.

Code samples

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

Parameters

Name In Type Required Description
deploymentId path string true Unique identifier of the deployment.
monitoringBatchId path string true ID of the monitoring batch.

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/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/

Retrieve a monitoring batch in a deployment.

Code samples

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

Parameters

Name In Type Required Description
deploymentId path string true Unique identifier of the deployment.
monitoringBatchId path string true ID of the monitoring batch.

Example responses

200 Response

{
  "batchPredictionJobId": "string",
  "batchPredictionJobStatus": "INITIALIZING",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string",
    "name": "string"
  },
  "description": "string",
  "earliestPredictionTimestamp": "2019-08-24T14:15:22Z",
  "externalContextUrl": "http://example.com",
  "id": "string",
  "isLocked": true,
  "latestPredictionTimestamp": "2019-08-24T14:15:22Z",
  "name": "string",
  "predictionsCount": 0,
  "serviceHealth": {
    "message": "string",
    "status": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK none MonitoringBatch

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

BearerAuth

PATCH /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/

Update a monitoring batch in a deployment.

Code samples

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

Body parameter

{
  "batchName": "string",
  "description": "string",
  "externalContextUrl": "http://example.com",
  "isLocked": true
}

Parameters

Name In Type Required Description
deploymentId path string true Unique identifier of the deployment.
monitoringBatchId path string true ID of the monitoring batch.
body body MonitoringBatchCreateUpdate false none

Example responses

200 Response

{
  "batchPredictionJobId": "string",
  "batchPredictionJobStatus": "INITIALIZING",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string",
    "name": "string"
  },
  "description": "string",
  "earliestPredictionTimestamp": "2019-08-24T14:15:22Z",
  "externalContextUrl": "http://example.com",
  "id": "string",
  "isLocked": true,
  "latestPredictionTimestamp": "2019-08-24T14:15:22Z",
  "name": "string",
  "predictionsCount": 0,
  "serviceHealth": {
    "message": "string",
    "status": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK none MonitoringBatch

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

BearerAuth

GET /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/models/

List information about models that have data in a monitoring batch.

Code samples

curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/models/ \
  -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 ID of the model associated with a batch.
deploymentId path string true Unique identifier of the deployment.
monitoringBatchId path string true ID of the monitoring batch.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "batchId": "string",
      "endTime": "2019-08-24T14:15:22Z",
      "modelId": "string",
      "predictionsCount": 0,
      "startTime": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none MonitoringBatchModelListResponse

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

BearerAuth

GET /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/models/{modelId}/

Get information about a model that has data in a monitoring batch.

Code samples

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

Parameters

Name In Type Required Description
deploymentId path string true Unique identifier of the deployment.
monitoringBatchId path string true ID of the monitoring batch.
modelId path string true ID of the model.

Example responses

200 Response

{
  "batchId": "string",
  "endTime": "2019-08-24T14:15:22Z",
  "modelId": "string",
  "predictionsCount": 0,
  "startTime": "2019-08-24T14:15:22Z"
}

Responses

Status Meaning Description Schema
200 OK none MonitoringBatchModel

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

BearerAuth

PATCH /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/models/{modelId}/

Update information about model data in a batch.

Code samples

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

Body parameter

{
  "endTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z"
}

Parameters

Name In Type Required Description
deploymentId path string true Unique identifier of the deployment.
monitoringBatchId path string true ID of the monitoring batch.
modelId path string true ID of the model.
body body MonitoringBatchModelUpdate 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

Schemas

MonitoringBatch

{
  "batchPredictionJobId": "string",
  "batchPredictionJobStatus": "INITIALIZING",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string",
    "name": "string"
  },
  "description": "string",
  "earliestPredictionTimestamp": "2019-08-24T14:15:22Z",
  "externalContextUrl": "http://example.com",
  "id": "string",
  "isLocked": true,
  "latestPredictionTimestamp": "2019-08-24T14:15:22Z",
  "name": "string",
  "predictionsCount": 0,
  "serviceHealth": {
    "message": "string",
    "status": "string"
  }
}

Properties

Name Type Required Restrictions Description
batchPredictionJobId string,null true ID of the batch prediction job associated with the batch.
batchPredictionJobStatus string,null false Status of the batch prediction job associated with the batch
createdAt string(date-time) true Creation timestamp of the monitoring batch.
createdBy MonitoringBatchCreator true Creator of the monitoring batch.
description string,null true Description of the monitoring batch.
earliestPredictionTimestamp string(date-time) true Earliest prediction request timestamp in the monitoring batch.
externalContextUrl string,null(uri) true External URL associated with the batch.
id string true ID of the monitoring batch.
isLocked boolean true Whether or not predictions can be added to the batch
latestPredictionTimestamp string(date-time) true Latest prediction request timestamp in the monitoring batch.
name string true Name of the monitoring batch.
predictionsCount integer true Count of predictions rows in the monitoring batch.
serviceHealth MonitoringBatchServiceHealth true Service health of the monitoring batch.

Enumerated Values

Property Value
batchPredictionJobStatus [INITIALIZING, RUNNING, COMPLETED, ABORTED, FAILED, null]

MonitoringBatchCreateUpdate

{
  "batchName": "string",
  "description": "string",
  "externalContextUrl": "http://example.com",
  "isLocked": true
}

Properties

Name Type Required Restrictions Description
batchName string false Name of the monitoring batch.
description string,null false Description of the monitoring batch.
externalContextUrl string,null(uri) false External URL associated with the batch.
isLocked boolean,null false Whether or not predictions can be added to the batch

MonitoringBatchCreator

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

Creator of the monitoring batch.

Properties

Name Type Required Restrictions Description
id string true ID of the user who created the monitoring batch.
name string true Name of the user who created monitoring batch.

MonitoringBatchListResponse

{
  "count": 0,
  "data": [
    {
      "batchPredictionJobId": "string",
      "batchPredictionJobStatus": "INITIALIZING",
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": {
        "id": "string",
        "name": "string"
      },
      "description": "string",
      "earliestPredictionTimestamp": "2019-08-24T14:15:22Z",
      "externalContextUrl": "http://example.com",
      "id": "string",
      "isLocked": true,
      "latestPredictionTimestamp": "2019-08-24T14:15:22Z",
      "name": "string",
      "predictionsCount": 0,
      "serviceHealth": {
        "message": "string",
        "status": "string"
      }
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [MonitoringBatch] true List of monitoring batches.
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).
totalCount integer true The total number of items across all pages.

MonitoringBatchModel

{
  "batchId": "string",
  "endTime": "2019-08-24T14:15:22Z",
  "modelId": "string",
  "predictionsCount": 0,
  "startTime": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
batchId string true ID of this monitoring batch.
endTime string(date-time) true Latest time of a prediction on this model in this batch
modelId string true ID of a model with data on this batch
predictionsCount integer true Count of predictions rows on this model in this batch
startTime string(date-time) true Earliest time of a prediction on this model in this batch

MonitoringBatchModelListResponse

{
  "count": 0,
  "data": [
    {
      "batchId": "string",
      "endTime": "2019-08-24T14:15:22Z",
      "modelId": "string",
      "predictionsCount": 0,
      "startTime": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [MonitoringBatchModel] true List of models with data on a monitoring batch.
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).
totalCount integer true The total number of items across all pages.

MonitoringBatchModelUpdate

{
  "endTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
endTime string(date-time) false Latest time of predictions on this model in this batch.
startTime string(date-time) false Earliest time of predictions on this model in this batch.

MonitoringBatchServiceHealth

{
  "message": "string",
  "status": "string"
}

Service health of the monitoring batch.

Properties

Name Type Required Restrictions Description
message string true Monitoring batch service health message.
status string true Monitoring batch service health status.
Updated March 19, 2025