DataRobot API resources > API reference documentation > DataRobot REST API > Monitoring > Actuals configuration

Observability Configuration¶

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

POST /api/v2/deployments/{deploymentId}/actuals/fromDataset/¶

Submit actuals values for processing using catalog item. Submission of actuals is limited to 10,000,000 actuals per hour. For time series deployments, total actuals = number of actuals * number of forecast distances. For example, submitting 10 actuals for a deployment with 50 forecast distances = 500 total actuals. For multiclass deployments, a similar calculation is made where total actuals = number of actuals * number of classes. For example, submitting 10 actuals for a deployment with 20 classes = 200 actuals.

Code samples¶


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

Body parameter¶


{
  "actualValueColumn": "string",
  "associationIdColumn": "string",
  "datasetId": "string",
  "datasetVersionId": "string",
  "keepActualsWithoutPredictions": true,
  "password": "string",
  "timestampColumn": "string",
  "user": "string",
  "wasActedOnColumn": "string"
}

Parameters

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

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Submitted successfully. See Location header.	None
422	Unprocessable Entity	Unable to process the Actuals submission request.	None
429	Too Many Requests	The number of actuals uploaded this hour exceeds the limit of 10000000 rows.	None

Response Headers¶

Status	Header	Type	Format	Description
202	Location	string		URL for tracking async job status.

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

BearerAuth

POST /api/v2/deployments/{deploymentId}/actuals/fromJSON/¶

Submit actuals values for processing. Values are not processed immediately and may take some time to propagate through deployment systems. Submission of actuals is limited to 10,000,000 actuals per hour. For time series deployments, total actuals = number of actuals * number of forecast distances. For example, submitting 10 actuals for a deployment with 50 forecast distances = 500 total actuals. For multiclass deployments, a similar calculation is made where total actuals = number of actuals * number of classes. For example, submitting 10 actuals for a deployment with 20 classes = 200 actuals.

Code samples¶


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

Body parameter¶


{
  "data": [
    {
      "actualValue": 0,
      "associationId": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "wasActedOn": true
    }
  ],
  "keepActualsWithoutPredictions": true
}

Parameters

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

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Submitted successfully. See Location header.	None
422	Unprocessable Entity	Unable to process the Actuals submission request.	None
429	Too Many Requests	The number of actuals uploaded this hour exceeds the limit of 10000000 rows.	None

Response Headers¶

Status	Header	Type	Format	Description
202	Location	string		URL for tracking async job status.

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

BearerAuth

POST /api/v2/deployments/{deploymentId}/monitoringDataDeletions/¶

Delete deployment monitoring data.

Code samples¶


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

Body parameter¶


{
  "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	MonitoringDataDeletePayload	false	none

Responses¶

Status	Meaning	Description	Schema
200	OK	none	None
404	Not Found	Deployment or model 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}/segmentAttributes/¶

Retrieve deployment segment attributes.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
monitoringType	query	string	false	The monitoring type for which segment attributes are being retrieved.
deploymentId	path	string	true	Unique identifier of the deployment.

Enumerated Values¶

Parameter	Value
monitoringType	[`serviceHealth`, `dataDrift`, `accuracy`, `humility`, `customMetrics`, `geospatial`]

Example responses¶

200 Response


{
  "data": [
    "string"
  ],
  "monitoringType": "serviceHealth"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	SegmentAttributesRetrieveResponse

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

BearerAuth

GET /api/v2/deployments/{deploymentId}/segmentValues/¶

Retrieve deployment segment values.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/segmentValues/ \
  -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.
segmentAttribute	query	string	false	The name of the segment attribute whose values the user wants to retrieve.
search	query	string	false	The search query to filter the list of segment values.
deploymentId	path	string	true	Unique identifier of the deployment.

Example responses¶

200 Response


{
  "count": 0,
  "data": [
    {
      "segmentAttribute": "string",
      "value": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	SegmentValuesRetrieveResponse

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

BearerAuth

Schemas¶

Actual


{
  "actualValue": 0,
  "associationId": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "wasActedOn": true
}

Properties¶

Name	Type	Required	Restrictions	Description
actualValue	any	true		The actual value of a prediction. Will be numeric for regression models and a string label for classification models.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	integer	false		none

or

Name	Type	Required	Restrictions	Description
» anonymous	number	false		none

or

Name	Type	Required	Restrictions	Description
» anonymous	string	false		none

continued

Name	Type	Required	Restrictions	Description
associationId	string	true	maxLength: 128	A unique identifier used with a predicted row.
timestamp	string,null(date-time)	false		The datetime when actual values were obtained, formatted according to RFC3339.
wasActedOn	boolean,null	false		Indicates if the prediction was acted on in a way that could have affected the actual outcome. For example, if a hospital patient is predicted to be readmitted in 30 days, extra procedures or new medication might be given to mitigate this problem, influencing the actual outcome of the prediction.

DeploymentActuals


{
  "data": [
    {
      "actualValue": 0,
      "associationId": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "wasActedOn": true
    }
  ],
  "keepActualsWithoutPredictions": true
}

Properties¶

Name	Type	Required	Restrictions	Description
data	[Actual]	true	minItems: 1	A list of `actual` objects that describes actual values. Minimum size of the list is 1 and maximum size is 10000 items. An `actual` object has the following schema.
keepActualsWithoutPredictions	boolean	false		Indicates if actual without predictions are kept.

DeploymentDatasetCreate


{
  "actualValueColumn": "string",
  "associationIdColumn": "string",
  "datasetId": "string",
  "datasetVersionId": "string",
  "keepActualsWithoutPredictions": true,
  "password": "string",
  "timestampColumn": "string",
  "user": "string",
  "wasActedOnColumn": "string"
}

Properties¶

Name	Type	Required	Description
actualValueColumn	string	true	Column name that contains actual values.
associationIdColumn	string	true	Column name that contains unique identifiers used with a predicted rows.
datasetId	string	true	The ID of dataset from catalog.
datasetVersionId	string,null	false	Version of dataset to retrieve.
keepActualsWithoutPredictions	boolean	false	Indicates if actual without predictions are kept.
password	string	false	The password for database authentication.
timestampColumn	string	false	Column name that contain datetime when actual values were obtained.
user	string	false	The username for database authentication.
wasActedOnColumn	string	false	Column name that contains boolean values if any action was made based on predictions data.

MonitoringDataDeletePayload


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

Properties¶

Name	Type	Required	Description
end	string,null(date-time)	false	End of the period to delete monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: `2019-08-01T00:00:00Z`.
modelId	string	true	The id of the model for which monitoring data are being deleted.
start	string,null(date-time)	false	Start of the period to delete monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: `2019-08-01T00:00:00Z`.

SegmentAttributesRetrieveResponse


{
  "data": [
    "string"
  ],
  "monitoringType": "serviceHealth"
}

Properties¶

Name	Type	Required	Restrictions	Description
data	[string]	true	maxItems: 100 minItems: 1	The segment attributes that were retrieved.
monitoringType	string	true		The monitoring type for which segment attributes are being retrieved.

Enumerated Values¶

Property	Value
monitoringType	[`serviceHealth`, `dataDrift`, `accuracy`, `humility`, `customMetrics`, `geospatial`]

SegmentValue


{
  "segmentAttribute": "string",
  "value": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
segmentAttribute	string	true		Name of the segment attribute.
value	string	true		The segment value.

SegmentValuesRetrieveResponse


{
  "count": 0,
  "data": [
    {
      "segmentAttribute": "string",
      "value": "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	[SegmentValue]	true	maxItems: 100	List of segment values.
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.

Observability Configuration¶

POST /api/v2/deployments/{deploymentId}/actuals/fromDataset/¶

Code samples¶

Body parameter¶

Parameters

Responses¶

Response Headers¶

POST /api/v2/deployments/{deploymentId}/actuals/fromJSON/¶

Code samples¶

Body parameter¶

Parameters

Responses¶

Response Headers¶

POST /api/v2/deployments/{deploymentId}/monitoringDataDeletions/¶

Code samples¶

Body parameter¶

Parameters

Responses¶

GET /api/v2/deployments/{deploymentId}/segmentAttributes/¶

Code samples¶

Parameters

Enumerated Values¶

Example responses¶

Responses¶

GET /api/v2/deployments/{deploymentId}/segmentValues/¶

Code samples¶

Parameters

Example responses¶

Responses¶

Schemas¶

Actual

Properties¶

DeploymentActuals

Properties¶

DeploymentDatasetCreate

Properties¶

MonitoringDataDeletePayload

Properties¶

SegmentAttributesRetrieveResponse

Properties¶

Enumerated Values¶

SegmentValue

Properties¶

SegmentValuesRetrieveResponse

Properties¶

Was this page helpful?

Great! Let us know what you found helpful.

What can we do to improve the content?