Developer documentation > API reference > REST API > Monitoring > Batch monitoring

Batch monitoring¶

Use the endpoints described below to manage batch monitoring. You can view monitoring statistics organized by batch, instead of by time, with batch-enabled deployments. To do this, you can create batches, add predictions to those batches, and view service health, data drift, and accuracy statistics for the batches in your deployment.

Operation path: GET /api/v2/deployments/{deploymentId}/monitoringBatchLimits/

Authentication requirements: BearerAuth

Get the limits related to monitoring batches.

Parameters

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

Responses¶

Status	Meaning	Description	Schema
200	OK	none	None

List monitoring batches by deployment ID¶

Operation path: GET /api/v2/deployments/{deploymentId}/monitoringBatches/

Authentication requirements: BearerAuth

List monitoring batches in a deployment.

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

{
  "properties": {
    "count": {
      "description": "Number of items returned on this page.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "List of monitoring batches.",
      "items": {
        "properties": {
          "batchPredictionJobId": {
            "description": "ID of the batch prediction job associated with the batch.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "batchPredictionJobStatus": {
            "default": null,
            "description": "Status of the batch prediction job associated with the batch",
            "enum": [
              "INITIALIZING",
              "RUNNING",
              "COMPLETED",
              "ABORTED",
              "FAILED",
              null
            ],
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "createdAt": {
            "description": "Creation timestamp of the monitoring batch.",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "createdBy": {
            "description": "Creator of the monitoring batch.",
            "properties": {
              "id": {
                "description": "ID of the user who created the monitoring batch.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "name": {
                "description": "Name of the user who created monitoring batch.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "id",
              "name"
            ],
            "type": "object"
          },
          "description": {
            "description": "Description of the monitoring batch.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "earliestPredictionTimestamp": {
            "description": "Earliest prediction request timestamp in the monitoring batch.",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "externalContextUrl": {
            "description": "External URL associated with the batch.",
            "format": "uri",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "id": {
            "description": "ID of the monitoring batch.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "isLocked": {
            "description": "Whether or not predictions can be added to the batch",
            "type": "boolean",
            "x-versionadded": "v2.33"
          },
          "latestPredictionTimestamp": {
            "description": "Latest prediction request timestamp in the monitoring batch.",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "Name of the monitoring batch.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "predictionsCount": {
            "description": "Count of predictions rows in the monitoring batch.",
            "type": "integer",
            "x-versionadded": "v2.33"
          },
          "serviceHealth": {
            "description": "Service health of the monitoring batch.",
            "properties": {
              "message": {
                "description": "Monitoring batch service health message.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "status": {
                "description": "Monitoring batch service health status.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "message",
              "status"
            ],
            "type": "object"
          }
        },
        "required": [
          "batchPredictionJobId",
          "createdAt",
          "createdBy",
          "description",
          "earliestPredictionTimestamp",
          "externalContextUrl",
          "id",
          "isLocked",
          "latestPredictionTimestamp",
          "name",
          "predictionsCount",
          "serviceHealth"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "URL pointing to the next page (if null, there is no next page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "URL pointing to the previous page (if null, there is no previous page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "The total number of items across all pages.",
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	MonitoringBatchListResponse

Create a monitoring batch by deployment ID¶

Operation path: POST /api/v2/deployments/{deploymentId}/monitoringBatches/

Authentication requirements: BearerAuth

Create a monitoring batch for a deployment.

Body parameter¶

{
  "properties": {
    "batchName": {
      "description": "Name of the monitoring batch.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "description": {
      "description": "Description of the monitoring batch.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "externalContextUrl": {
      "description": "External URL associated with the batch.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "isLocked": {
      "description": "Whether or not predictions can be added to the batch",
      "type": [
        "boolean",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}

Parameters

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

Example responses¶

200 Response

{
  "properties": {
    "batchPredictionJobId": {
      "description": "ID of the batch prediction job associated with the batch.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "batchPredictionJobStatus": {
      "default": null,
      "description": "Status of the batch prediction job associated with the batch",
      "enum": [
        "INITIALIZING",
        "RUNNING",
        "COMPLETED",
        "ABORTED",
        "FAILED",
        null
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "createdAt": {
      "description": "Creation timestamp of the monitoring batch.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "Creator of the monitoring batch.",
      "properties": {
        "id": {
          "description": "ID of the user who created the monitoring batch.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "name": {
          "description": "Name of the user who created monitoring batch.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "description": {
      "description": "Description of the monitoring batch.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "earliestPredictionTimestamp": {
      "description": "Earliest prediction request timestamp in the monitoring batch.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "externalContextUrl": {
      "description": "External URL associated with the batch.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "id": {
      "description": "ID of the monitoring batch.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "isLocked": {
      "description": "Whether or not predictions can be added to the batch",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "latestPredictionTimestamp": {
      "description": "Latest prediction request timestamp in the monitoring batch.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "Name of the monitoring batch.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "predictionsCount": {
      "description": "Count of predictions rows in the monitoring batch.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "serviceHealth": {
      "description": "Service health of the monitoring batch.",
      "properties": {
        "message": {
          "description": "Monitoring batch service health message.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "status": {
          "description": "Monitoring batch service health status.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "message",
        "status"
      ],
      "type": "object"
    }
  },
  "required": [
    "batchPredictionJobId",
    "createdAt",
    "createdBy",
    "description",
    "earliestPredictionTimestamp",
    "externalContextUrl",
    "id",
    "isLocked",
    "latestPredictionTimestamp",
    "name",
    "predictionsCount",
    "serviceHealth"
  ],
  "type": "object"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	MonitoringBatch

Delete a monitoring batch by deployment ID¶

Operation path: DELETE /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/

Authentication requirements: BearerAuth

Delete a monitoring batch in a deployment.

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

Retrieve a monitoring batch by deployment ID¶

Operation path: GET /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/

Authentication requirements: BearerAuth

Retrieve a monitoring batch in a deployment.

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

{
  "properties": {
    "batchPredictionJobId": {
      "description": "ID of the batch prediction job associated with the batch.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "batchPredictionJobStatus": {
      "default": null,
      "description": "Status of the batch prediction job associated with the batch",
      "enum": [
        "INITIALIZING",
        "RUNNING",
        "COMPLETED",
        "ABORTED",
        "FAILED",
        null
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "createdAt": {
      "description": "Creation timestamp of the monitoring batch.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "Creator of the monitoring batch.",
      "properties": {
        "id": {
          "description": "ID of the user who created the monitoring batch.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "name": {
          "description": "Name of the user who created monitoring batch.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "description": {
      "description": "Description of the monitoring batch.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "earliestPredictionTimestamp": {
      "description": "Earliest prediction request timestamp in the monitoring batch.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "externalContextUrl": {
      "description": "External URL associated with the batch.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "id": {
      "description": "ID of the monitoring batch.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "isLocked": {
      "description": "Whether or not predictions can be added to the batch",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "latestPredictionTimestamp": {
      "description": "Latest prediction request timestamp in the monitoring batch.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "Name of the monitoring batch.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "predictionsCount": {
      "description": "Count of predictions rows in the monitoring batch.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "serviceHealth": {
      "description": "Service health of the monitoring batch.",
      "properties": {
        "message": {
          "description": "Monitoring batch service health message.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "status": {
          "description": "Monitoring batch service health status.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "message",
        "status"
      ],
      "type": "object"
    }
  },
  "required": [
    "batchPredictionJobId",
    "createdAt",
    "createdBy",
    "description",
    "earliestPredictionTimestamp",
    "externalContextUrl",
    "id",
    "isLocked",
    "latestPredictionTimestamp",
    "name",
    "predictionsCount",
    "serviceHealth"
  ],
  "type": "object"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	MonitoringBatch

Update a monitoring batch by deployment ID¶

Operation path: PATCH /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/

Authentication requirements: BearerAuth

Update a monitoring batch in a deployment.

Body parameter¶

{
  "properties": {
    "batchName": {
      "description": "Name of the monitoring batch.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "description": {
      "description": "Description of the monitoring batch.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "externalContextUrl": {
      "description": "External URL associated with the batch.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "isLocked": {
      "description": "Whether or not predictions can be added to the batch",
      "type": [
        "boolean",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}

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

{
  "properties": {
    "batchPredictionJobId": {
      "description": "ID of the batch prediction job associated with the batch.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "batchPredictionJobStatus": {
      "default": null,
      "description": "Status of the batch prediction job associated with the batch",
      "enum": [
        "INITIALIZING",
        "RUNNING",
        "COMPLETED",
        "ABORTED",
        "FAILED",
        null
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "createdAt": {
      "description": "Creation timestamp of the monitoring batch.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "Creator of the monitoring batch.",
      "properties": {
        "id": {
          "description": "ID of the user who created the monitoring batch.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "name": {
          "description": "Name of the user who created monitoring batch.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "description": {
      "description": "Description of the monitoring batch.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "earliestPredictionTimestamp": {
      "description": "Earliest prediction request timestamp in the monitoring batch.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "externalContextUrl": {
      "description": "External URL associated with the batch.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "id": {
      "description": "ID of the monitoring batch.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "isLocked": {
      "description": "Whether or not predictions can be added to the batch",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "latestPredictionTimestamp": {
      "description": "Latest prediction request timestamp in the monitoring batch.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "Name of the monitoring batch.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "predictionsCount": {
      "description": "Count of predictions rows in the monitoring batch.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "serviceHealth": {
      "description": "Service health of the monitoring batch.",
      "properties": {
        "message": {
          "description": "Monitoring batch service health message.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "status": {
          "description": "Monitoring batch service health status.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "message",
        "status"
      ],
      "type": "object"
    }
  },
  "required": [
    "batchPredictionJobId",
    "createdAt",
    "createdBy",
    "description",
    "earliestPredictionTimestamp",
    "externalContextUrl",
    "id",
    "isLocked",
    "latestPredictionTimestamp",
    "name",
    "predictionsCount",
    "serviceHealth"
  ],
  "type": "object"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	MonitoringBatch

List information about models that have data by deployment ID¶

Operation path: GET /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/models/

Authentication requirements: BearerAuth

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

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

{
  "properties": {
    "count": {
      "description": "Number of items returned on this page.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "List of models with data on a monitoring batch.",
      "items": {
        "properties": {
          "batchId": {
            "description": "ID of this monitoring batch.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "endTime": {
            "description": "Latest time of a prediction on this model in this batch",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "modelId": {
            "description": "ID of a model with data on this batch",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "predictionsCount": {
            "description": "Count of predictions rows on this model in this batch",
            "type": "integer",
            "x-versionadded": "v2.33"
          },
          "startTime": {
            "description": "Earliest time of a prediction on this model in this batch",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "batchId",
          "endTime",
          "modelId",
          "predictionsCount",
          "startTime"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "URL pointing to the next page (if null, there is no next page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "URL pointing to the previous page (if null, there is no previous page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "The total number of items across all pages.",
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	MonitoringBatchModelListResponse

Get information about a model that has data by deployment ID¶

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

Authentication requirements: BearerAuth

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

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

{
  "properties": {
    "batchId": {
      "description": "ID of this monitoring batch.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "endTime": {
      "description": "Latest time of a prediction on this model in this batch",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "modelId": {
      "description": "ID of a model with data on this batch",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "predictionsCount": {
      "description": "Count of predictions rows on this model in this batch",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "startTime": {
      "description": "Earliest time of a prediction on this model in this batch",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "batchId",
    "endTime",
    "modelId",
    "predictionsCount",
    "startTime"
  ],
  "type": "object"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	MonitoringBatchModel

Update information about model data by deployment ID¶

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

Authentication requirements: BearerAuth

Update information about model data in a batch.

Body parameter¶

{
  "properties": {
    "endTime": {
      "description": "Latest time of predictions on this model in this batch.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "startTime": {
      "description": "Earliest time of predictions on this model in this batch.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}

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

Schemas¶

MonitoringBatch

{
  "properties": {
    "batchPredictionJobId": {
      "description": "ID of the batch prediction job associated with the batch.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "batchPredictionJobStatus": {
      "default": null,
      "description": "Status of the batch prediction job associated with the batch",
      "enum": [
        "INITIALIZING",
        "RUNNING",
        "COMPLETED",
        "ABORTED",
        "FAILED",
        null
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "createdAt": {
      "description": "Creation timestamp of the monitoring batch.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "Creator of the monitoring batch.",
      "properties": {
        "id": {
          "description": "ID of the user who created the monitoring batch.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "name": {
          "description": "Name of the user who created monitoring batch.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "description": {
      "description": "Description of the monitoring batch.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "earliestPredictionTimestamp": {
      "description": "Earliest prediction request timestamp in the monitoring batch.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "externalContextUrl": {
      "description": "External URL associated with the batch.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "id": {
      "description": "ID of the monitoring batch.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "isLocked": {
      "description": "Whether or not predictions can be added to the batch",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "latestPredictionTimestamp": {
      "description": "Latest prediction request timestamp in the monitoring batch.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "Name of the monitoring batch.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "predictionsCount": {
      "description": "Count of predictions rows in the monitoring batch.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "serviceHealth": {
      "description": "Service health of the monitoring batch.",
      "properties": {
        "message": {
          "description": "Monitoring batch service health message.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "status": {
          "description": "Monitoring batch service health status.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "message",
        "status"
      ],
      "type": "object"
    }
  },
  "required": [
    "batchPredictionJobId",
    "createdAt",
    "createdBy",
    "description",
    "earliestPredictionTimestamp",
    "externalContextUrl",
    "id",
    "isLocked",
    "latestPredictionTimestamp",
    "name",
    "predictionsCount",
    "serviceHealth"
  ],
  "type": "object"
}

Properties¶

Name	Type	Required	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

{
  "properties": {
    "batchName": {
      "description": "Name of the monitoring batch.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "description": {
      "description": "Description of the monitoring batch.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "externalContextUrl": {
      "description": "External URL associated with the batch.",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "isLocked": {
      "description": "Whether or not predictions can be added to the batch",
      "type": [
        "boolean",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}

Properties¶

Name	Type	Required	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

{
  "description": "Creator of the monitoring batch.",
  "properties": {
    "id": {
      "description": "ID of the user who created the monitoring batch.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "Name of the user who created monitoring batch.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "type": "object"
}

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

{
  "properties": {
    "count": {
      "description": "Number of items returned on this page.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "List of monitoring batches.",
      "items": {
        "properties": {
          "batchPredictionJobId": {
            "description": "ID of the batch prediction job associated with the batch.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "batchPredictionJobStatus": {
            "default": null,
            "description": "Status of the batch prediction job associated with the batch",
            "enum": [
              "INITIALIZING",
              "RUNNING",
              "COMPLETED",
              "ABORTED",
              "FAILED",
              null
            ],
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "createdAt": {
            "description": "Creation timestamp of the monitoring batch.",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "createdBy": {
            "description": "Creator of the monitoring batch.",
            "properties": {
              "id": {
                "description": "ID of the user who created the monitoring batch.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "name": {
                "description": "Name of the user who created monitoring batch.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "id",
              "name"
            ],
            "type": "object"
          },
          "description": {
            "description": "Description of the monitoring batch.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "earliestPredictionTimestamp": {
            "description": "Earliest prediction request timestamp in the monitoring batch.",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "externalContextUrl": {
            "description": "External URL associated with the batch.",
            "format": "uri",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "id": {
            "description": "ID of the monitoring batch.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "isLocked": {
            "description": "Whether or not predictions can be added to the batch",
            "type": "boolean",
            "x-versionadded": "v2.33"
          },
          "latestPredictionTimestamp": {
            "description": "Latest prediction request timestamp in the monitoring batch.",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "Name of the monitoring batch.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "predictionsCount": {
            "description": "Count of predictions rows in the monitoring batch.",
            "type": "integer",
            "x-versionadded": "v2.33"
          },
          "serviceHealth": {
            "description": "Service health of the monitoring batch.",
            "properties": {
              "message": {
                "description": "Monitoring batch service health message.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "status": {
                "description": "Monitoring batch service health status.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "message",
              "status"
            ],
            "type": "object"
          }
        },
        "required": [
          "batchPredictionJobId",
          "createdAt",
          "createdBy",
          "description",
          "earliestPredictionTimestamp",
          "externalContextUrl",
          "id",
          "isLocked",
          "latestPredictionTimestamp",
          "name",
          "predictionsCount",
          "serviceHealth"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "URL pointing to the next page (if null, there is no next page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "URL pointing to the previous page (if null, there is no previous page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "The total number of items across all pages.",
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}

Properties¶

Name	Type	Required	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

{
  "properties": {
    "batchId": {
      "description": "ID of this monitoring batch.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "endTime": {
      "description": "Latest time of a prediction on this model in this batch",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "modelId": {
      "description": "ID of a model with data on this batch",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "predictionsCount": {
      "description": "Count of predictions rows on this model in this batch",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "startTime": {
      "description": "Earliest time of a prediction on this model in this batch",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "batchId",
    "endTime",
    "modelId",
    "predictionsCount",
    "startTime"
  ],
  "type": "object"
}

Properties¶

Name	Type	Required	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

{
  "properties": {
    "count": {
      "description": "Number of items returned on this page.",
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "List of models with data on a monitoring batch.",
      "items": {
        "properties": {
          "batchId": {
            "description": "ID of this monitoring batch.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "endTime": {
            "description": "Latest time of a prediction on this model in this batch",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "modelId": {
            "description": "ID of a model with data on this batch",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "predictionsCount": {
            "description": "Count of predictions rows on this model in this batch",
            "type": "integer",
            "x-versionadded": "v2.33"
          },
          "startTime": {
            "description": "Earliest time of a prediction on this model in this batch",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "batchId",
          "endTime",
          "modelId",
          "predictionsCount",
          "startTime"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "URL pointing to the next page (if null, there is no next page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "URL pointing to the previous page (if null, there is no previous page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "The total number of items across all pages.",
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}

Properties¶

Name	Type	Required	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

{
  "properties": {
    "endTime": {
      "description": "Latest time of predictions on this model in this batch.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "startTime": {
      "description": "Earliest time of predictions on this model in this batch.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}

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

{
  "description": "Service health of the monitoring batch.",
  "properties": {
    "message": {
      "description": "Monitoring batch service health message.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "status": {
      "description": "Monitoring batch service health status.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "message",
    "status"
  ],
  "type": "object"
}

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.

Batch monitoring¶

Get the limits related by deployment ID¶

Parameters

Responses¶

List monitoring batches by deployment ID¶

Parameters

Enumerated Values¶

Example responses¶

Responses¶

Create a monitoring batch by deployment ID¶

Body parameter¶

Parameters

Example responses¶

Responses¶

Delete a monitoring batch by deployment ID¶

Parameters

Responses¶

Retrieve a monitoring batch by deployment ID¶

Parameters

Example responses¶

Responses¶

Update a monitoring batch by deployment ID¶

Body parameter¶

Parameters

Example responses¶

Responses¶

List information about models that have data by deployment ID¶

Parameters

Example responses¶

Responses¶

Get information about a model that has data by deployment ID¶

Parameters

Example responses¶

Responses¶

Update information about model data by deployment ID¶

Body parameter¶

Parameters

Responses¶

Schemas¶

MonitoringBatch

Properties¶

Enumerated Values¶

MonitoringBatchCreateUpdate

Properties¶

MonitoringBatchCreator

Properties¶

MonitoringBatchListResponse

Properties¶

MonitoringBatchModel

Properties¶

MonitoringBatchModelListResponse

Properties¶

MonitoringBatchModelUpdate

Properties¶

MonitoringBatchServiceHealth

Properties¶