DataRobot API resources > API reference documentation > DataRobot REST API > Monitoring > Custom metrics

Observability Custom Metrics¶

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

POST /api/v2/customJobs/fromHostedCustomMetricGalleryTemplate/¶

Creates a custom job from the hosted custom metric template.

Code samples¶


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

Body parameter¶


{
  "description": "",
  "name": "string",
  "sidecarDeploymentId": "string",
  "templateId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	CustomJobFromGalleryTemplateCreate	false	none

Example responses¶


{
  "created": "string",
  "description": "string",
  "entryPoint": "string",
  "environmentId": "string",
  "environmentVersionId": "string",
  "id": "string",
  "items": [
    {
      "commitSha": "string",
      "created": "string",
      "fileName": "string",
      "filePath": "string",
      "fileSource": "string",
      "id": "string",
      "ref": "string",
      "repositoryFilePath": "string",
      "repositoryLocation": "string",
      "repositoryName": "string"
    }
  ],
  "jobType": "default",
  "lastRun": "string",
  "name": "string",
  "resources": {
    "egressNetworkPolicy": "none",
    "resourceBundleId": "string"
  },
  "runtimeParameters": [
    {
      "allowEmpty": true,
      "credentialType": "adlsGen2Oauth",
      "currentValue": "string",
      "defaultValue": "string",
      "description": "string",
      "fieldName": "string",
      "maxValue": 0,
      "minValue": 0,
      "overrideValue": "string",
      "type": "boolean"
    }
  ],
  "updated": "string"
}

Responses¶

Status	Meaning	Description	Schema
201	Created	Custom metric test job creation started.	CustomJobResponse
403	Forbidden	User does not have permission to create a custom job.	None

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

BearerAuth

GET /api/v2/customJobs/{customJobId}/customMetrics/¶

List all of the custom metrics associated with a custom job.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	This many results will be skipped.
limit	query	integer	false	At most this many results are returned.
customJobId	path	string	true	ID of the custom job.

Example responses¶


{
  "baselineValues": [
    {
      "value": 0
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "deployment": {
    "createdAt": "2019-08-24T14:15:22Z",
    "creatorFirstName": "string",
    "creatorGravatarHash": "string",
    "creatorLastName": "string",
    "creatorUsername": "string",
    "id": "string",
    "name": "string"
  },
  "description": "",
  "directionality": "higherIsBetter",
  "id": "string",
  "isModelSpecific": true,
  "name": "string",
  "sampleCount": {
    "columnName": "string"
  },
  "schedule": {
    "dayOfMonth": [
      "*"
    ],
    "dayOfWeek": [
      "*"
    ],
    "hour": [
      "*"
    ],
    "minute": [
      "*"
    ],
    "month": [
      "*"
    ]
  },
  "timeStep": "hour",
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "type": "average",
  "units": "string",
  "value": {
    "columnName": "string"
  }
}

Responses¶

Status	Meaning	Description	Schema
201	Created	Custom metrics associated with custom job.	MetricCreateFromCustomJobResponse
403	Forbidden	User does not have permission to custom jobs.	None

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

BearerAuth

DELETE /api/v2/customJobs/{customJobId}/customMetrics/{customMetricId}/¶

Delete a custom metric associated with a custom job.

Code samples¶


curl -X DELETE https://app.datarobot.com/api/v2/customJobs/{customJobId}/customMetrics/{customMetricId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
customJobId	path	string	true	ID of the custom job.
customMetricId	path	string	true	ID of the custom metric.

Responses¶

Status	Meaning	Description	Schema
204	No Content	none	None
403	Forbidden	User does not have permission to custom jobs.	None

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

BearerAuth

PATCH /api/v2/customJobs/{customJobId}/customMetrics/{customMetricId}/¶

Update custom metric associated with a custom job.

Code samples¶


curl -X PATCH https://app.datarobot.com/api/v2/customJobs/{customJobId}/customMetrics/{customMetricId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "baselineValues": [
    {
      "value": 0
    }
  ],
  "batch": {
    "columnName": "string"
  },
  "description": "string",
  "directionality": "higherIsBetter",
  "name": "string",
  "sampleCount": {
    "columnName": "string"
  },
  "schedule": {
    "dayOfMonth": [
      "*"
    ],
    "dayOfWeek": [
      "*"
    ],
    "hour": [
      "*"
    ],
    "minute": [
      "*"
    ],
    "month": [
      "*"
    ]
  },
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "type": "average",
  "units": "string",
  "value": {
    "columnName": "string"
  }
}

Parameters

Name	In	Type	Required	Description
customJobId	path	string	true	ID of the custom job.
customMetricId	path	string	true	ID of the custom metric.
body	body	CustomJobCustomMetricUpdate	false	none

Example responses¶


{
  "baselineValues": [
    {
      "value": 0
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "deployment": {
    "createdAt": "2019-08-24T14:15:22Z",
    "creatorFirstName": "string",
    "creatorGravatarHash": "string",
    "creatorLastName": "string",
    "creatorUsername": "string",
    "id": "string",
    "name": "string"
  },
  "description": "",
  "directionality": "higherIsBetter",
  "id": "string",
  "isModelSpecific": true,
  "name": "string",
  "sampleCount": {
    "columnName": "string"
  },
  "schedule": {
    "dayOfMonth": [
      "*"
    ],
    "dayOfWeek": [
      "*"
    ],
    "hour": [
      "*"
    ],
    "minute": [
      "*"
    ],
    "month": [
      "*"
    ]
  },
  "timeStep": "hour",
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "type": "average",
  "units": "string",
  "value": {
    "columnName": "string"
  }
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Updated custom metric.	MetricCreateFromCustomJobResponse
403	Forbidden	User does not have permission to custom jobs.	None

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

BearerAuth

GET /api/v2/customJobs/{customJobId}/hostedCustomMetricTemplate/¶

Retrieve a template for hosted custom metric job.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
customJobId	path	string	true	ID of the custom job.

Example responses¶


{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customJobId": "string",
  "directionality": "higherIsBetter",
  "id": "string",
  "isModelSpecific": true,
  "timeStep": "hour",
  "type": "average",
  "units": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Hosted custom metric template retrieved.	HostedCustomMetricTemplateResponse
403	Forbidden	User does not have permission to retrieve a custom metric test job.	None
404	Not Found	Custom job does not exist or user does not have permission to access it.	None

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

BearerAuth

PATCH /api/v2/customJobs/{customJobId}/hostedCustomMetricTemplate/¶

Updates a template for hosted custom metric job.

Code samples¶


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

Body parameter¶


{
  "directionality": "higherIsBetter",
  "isModelSpecific": true,
  "timeStep": "hour",
  "type": "average",
  "units": "string"
}

Parameters

Name	In	Type	Required	Description
customJobId	path	string	true	ID of the custom job.
body	body	HostedCustomMetricTemplateUpdate	false	none

Example responses¶


{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customJobId": "string",
  "directionality": "higherIsBetter",
  "id": "string",
  "isModelSpecific": true,
  "timeStep": "hour",
  "type": "average",
  "units": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

Responses¶

Status	Meaning	Description	Schema
201	Created	Hosted custom metric template updated.	HostedCustomMetricTemplateResponse
403	Forbidden	User does not have permission to update a custom metric test job.	None
404	Not Found	Custom job or template does not exist or user does not have permission to access it.	None
409	Conflict	Custom job have at least 1 associated deployment.	None

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

BearerAuth

POST /api/v2/customJobs/{customJobId}/hostedCustomMetricTemplate/¶

Creates a template for hosted custom metric job.

Code samples¶


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

Body parameter¶


{
  "directionality": "higherIsBetter",
  "isModelSpecific": true,
  "timeStep": "hour",
  "type": "average",
  "units": "string"
}

Parameters

Name	In	Type	Required	Description
customJobId	path	string	true	ID of the custom job.
body	body	HostedCustomMetricTemplateCreate	false	none

Example responses¶


{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customJobId": "string",
  "directionality": "higherIsBetter",
  "id": "string",
  "isModelSpecific": true,
  "timeStep": "hour",
  "type": "average",
  "units": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

Responses¶

Status	Meaning	Description	Schema
201	Created	Hosted custom metric template created.	HostedCustomMetricTemplateResponse
403	Forbidden	User does not have permission to create a custom metric test job.	None
404	Not Found	Custom job does not exist or user does not have permission to access it.	None
409	Conflict	Hosted custom metric template already exists.	None

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

BearerAuth

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

Retrieve a list of custom metrics.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/customMetrics/ \
  -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
deploymentId	path	string	true	Unique identifier of the deployment.

Example responses¶


{
  "count": 0,
  "data": [
    {
      "baselineValues": [
        {
          "value": 0
        }
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": {
        "id": "string"
      },
      "description": "string",
      "directionality": "higherIsBetter",
      "displayChart": true,
      "id": "string",
      "isModelSpecific": true,
      "name": "string",
      "sampleCount": {
        "columnName": "string"
      },
      "timeStep": "hour",
      "timestamp": {
        "columnName": "string",
        "timeFormat": "%m/%d/%Y"
      },
      "type": "average",
      "units": "string",
      "value": {
        "columnName": "string"
      }
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Success	MetricListResponse
403	Forbidden	User does not have permission to access a particular deployment or create a custom metric.	None

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

BearerAuth

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

Create a deployment custom metric.

Code samples¶


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

Body parameter¶


{
  "baselineValues": [
    {
      "value": 0
    }
  ],
  "description": "string",
  "directionality": "higherIsBetter",
  "isModelSpecific": true,
  "name": "string",
  "sampleCount": {
    "columnName": "string"
  },
  "timeStep": "hour",
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "type": "average",
  "units": "string",
  "value": {
    "columnName": "string"
  }
}

Parameters

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

Example responses¶


{
  "baselineValues": [
    {
      "value": 0
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string"
  },
  "description": "string",
  "directionality": "higherIsBetter",
  "displayChart": true,
  "id": "string",
  "isModelSpecific": true,
  "name": "string",
  "sampleCount": {
    "columnName": "string"
  },
  "timeStep": "hour",
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "type": "average",
  "units": "string",
  "value": {
    "columnName": "string"
  }
}

Responses¶

Status	Meaning	Description	Schema
201	Created	Custom metric is successfully created.	MetricEntity
403	Forbidden	User does not have permission to create a custom metric.	None

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

BearerAuth

POST /api/v2/deployments/{deploymentId}/customMetrics/fromCustomJob/¶

Create a deployment custom metric from an existing custom job.

Code samples¶


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

Body parameter¶


{
  "baselineValues": [
    {
      "value": 0
    }
  ],
  "customJobId": "string",
  "description": "",
  "name": "string",
  "sampleCount": {
    "columnName": "string"
  },
  "schedule": {
    "dayOfMonth": [
      "*"
    ],
    "dayOfWeek": [
      "*"
    ],
    "hour": [
      "*"
    ],
    "minute": [
      "*"
    ],
    "month": [
      "*"
    ]
  },
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "value": {
    "columnName": "string"
  }
}

Parameters

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

Example responses¶


{
  "baselineValues": [
    {
      "value": 0
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "deployment": {
    "createdAt": "2019-08-24T14:15:22Z",
    "creatorFirstName": "string",
    "creatorGravatarHash": "string",
    "creatorLastName": "string",
    "creatorUsername": "string",
    "id": "string",
    "name": "string"
  },
  "description": "",
  "directionality": "higherIsBetter",
  "id": "string",
  "isModelSpecific": true,
  "name": "string",
  "sampleCount": {
    "columnName": "string"
  },
  "schedule": {
    "dayOfMonth": [
      "*"
    ],
    "dayOfWeek": [
      "*"
    ],
    "hour": [
      "*"
    ],
    "minute": [
      "*"
    ],
    "month": [
      "*"
    ]
  },
  "timeStep": "hour",
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "type": "average",
  "units": "string",
  "value": {
    "columnName": "string"
  }
}

Responses¶

Status	Meaning	Description	Schema
201	Created	Custom metric is successfully created.	MetricCreateFromCustomJobResponse
403	Forbidden	User does not have permission to create a custom metric.	None

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

BearerAuth

DELETE /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/¶

Delete a custom metric.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
deploymentId	path	string	true	ID of the deployment
customMetricId	path	string	true	ID of the custom metric

Responses¶

Status	Meaning	Description	Schema
204	No Content	A custom metric was successfully deleted.	None
403	Forbidden	User does not have permission to delete a custom metric.	None
404	Not Found	Custom metric 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}/customMetrics/{customMetricId}/¶

Retrieve a single custom metric metadata.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
deploymentId	path	string	true	ID of the deployment
customMetricId	path	string	true	ID of the custom metric

Example responses¶


{
  "baselineValues": [
    {
      "value": 0
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string"
  },
  "description": "string",
  "directionality": "higherIsBetter",
  "displayChart": true,
  "id": "string",
  "isModelSpecific": true,
  "name": "string",
  "sampleCount": {
    "columnName": "string"
  },
  "timeStep": "hour",
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "type": "average",
  "units": "string",
  "value": {
    "columnName": "string"
  }
}

Responses¶

Status	Meaning	Description	Schema
200	OK	A given custom metric metadata.	MetricEntity
403	Forbidden	User does not have permission to access a particular deployment or custom metric metadata.	None

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

BearerAuth

PATCH /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/¶

Update given custom metric settings.

Code samples¶


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

Body parameter¶


{
  "baselineValues": [
    {
      "value": 0
    }
  ],
  "batch": {
    "columnName": "string"
  },
  "description": "string",
  "directionality": "higherIsBetter",
  "name": "string",
  "sampleCount": {
    "columnName": "string"
  },
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "type": "average",
  "units": "string",
  "value": {
    "columnName": "string"
  }
}

Parameters

Name	In	Type	Required	Description
deploymentId	path	string	true	ID of the deployment
customMetricId	path	string	true	ID of the custom metric
body	body	MetricUpdatePayload	false	none

Example responses¶


{
  "baselineValues": [
    {
      "value": 0
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string"
  },
  "description": "string",
  "directionality": "higherIsBetter",
  "displayChart": true,
  "id": "string",
  "isModelSpecific": true,
  "name": "string",
  "sampleCount": {
    "columnName": "string"
  },
  "timeStep": "hour",
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "type": "average",
  "units": "string",
  "value": {
    "columnName": "string"
  }
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Custom metric settings updated.	MetricEntity
403	Forbidden	User does not have permission to update the custom metric.	None

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

BearerAuth

GET /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/batchSummary/¶

Retrieve the summary of deployment batch custom metric.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
start	query	string(date-time)	false	Start of the period to retrieve monitoring stats, defaults to 7 days ago from the end of the period.
end	query	string(date-time)	false	End of the period to retrieve monitoring stats, defaults to the next top of the hour from now.
modelPackageId	query	string,null	false	The model package ID of related champion/challenger to retrieve custom metric values for.
modelId	query	string,null	false	The model ID of related champion/challenger to retrieve custom metric values for.
batchId	query	any	false	The id of the batch for which metrics are being retrieved.
deploymentId	path	string	true	ID of the deployment
customMetricId	path	string	true	ID of the custom metric

Example responses¶


{
  "metric": {
    "baselineValue": 0,
    "id": "string",
    "name": "string",
    "percentChange": 0,
    "sampleCount": 0,
    "unknownCategoriesCount": 0,
    "value": 0
  }
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Summary retrieved successfully.	CustomMetricBatchSummary
403	Forbidden	User does not have permission to read the custom metric summary.	None

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

BearerAuth

POST /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/fromDataset/¶

Upload custom metric values from dataset.

Code samples¶


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

Body parameter¶


{
  "associationId": {
    "columnName": "string"
  },
  "batch": {
    "columnName": "string"
  },
  "datasetId": "string",
  "geospatial": {
    "columnName": "string"
  },
  "modelId": null,
  "modelPackageId": null,
  "sampleCount": {
    "columnName": "string"
  },
  "segments": [
    {
      "column": "string",
      "name": "string"
    }
  ],
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "value": {
    "columnName": "string"
  }
}

Parameters

Name	In	Type	Required	Description
deploymentId	path	string	true	ID of the deployment
customMetricId	path	string	true	ID of the custom metric
body	body	MetricValuesFromDatasetPayload	false	none

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Custom metric values import started	None
403	Forbidden	User does not have permission to import custom metric values.	None

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

BearerAuth

POST /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/fromJSON/¶

Upload custom metric values from JSON.

Code samples¶


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

Body parameter¶


{
  "buckets": [
    {
      "sampleSize": 1,
      "timestamp": "2019-08-24T14:15:22Z",
      "value": 0
    }
  ],
  "dryRun": false,
  "modelId": null,
  "modelPackageId": null
}

Parameters

Name	In	Type	Required	Description
deploymentId	path	string	true	ID of the deployment
customMetricId	path	string	true	ID of the custom metric
body	body	MetricValuesFromJSONPayload	false	none

Example responses¶


{
  "baselineValues": [
    {
      "value": 0
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string"
  },
  "description": "string",
  "directionality": "higherIsBetter",
  "displayChart": true,
  "id": "string",
  "isModelSpecific": true,
  "name": "string",
  "sampleCount": {
    "columnName": "string"
  },
  "timeStep": "hour",
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "type": "average",
  "units": "string",
  "value": {
    "columnName": "string"
  }
}

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Custom metric values import started	MetricEntity
403	Forbidden	User does not have permission to import custom metric values.	None

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

BearerAuth

GET /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/summary/¶

Retrieve the summary of deployment custom metric.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
start	query	string(date-time)	false	Start of the period to retrieve monitoring stats, defaults to 7 days ago from the end of the period.
end	query	string(date-time)	false	End of the period to retrieve monitoring stats, defaults to the next top of the hour from now.
modelPackageId	query	string,null	false	The model package ID of related champion/challenger to retrieve custom metric values for.
modelId	query	string,null	false	The model ID of related champion/challenger to retrieve custom metric values for.
batchId	query	any	false	The id of the batch for which metrics are being retrieved.
deploymentId	path	string	true	ID of the deployment
customMetricId	path	string	true	ID of the custom metric

Example responses¶


{
  "metric": {
    "baselineValue": 0,
    "id": "string",
    "name": "string",
    "percentChange": 0,
    "sampleCount": 0,
    "unknownCategoriesCount": 0,
    "value": 0
  },
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  }
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Summary retrieved successfully.	CustomMetricSummary
403	Forbidden	User does not have permission to read the custom metric summary.	None

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

BearerAuth

GET /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/valuesOverBatch/¶

Retrieve custom metric values over batch.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
modelPackageId	query	string,null	false	The model package ID of related champion/challenger to retrieve batch custom metric values for.
modelId	query	string,null	false	The model ID of related champion/challenger to retrieve batch custom metric values for.
batchId	query	any	false	The id of the batch for which metrics are being retrieved.
deploymentId	path	string	true	ID of the deployment
customMetricId	path	string	true	ID of the custom metric

Example responses¶


{
  "buckets": [
    {
      "batch": {
        "createdAt": "2019-08-24T14:15:22Z",
        "id": "string",
        "lastPredictionTimestamp": "2019-08-24T14:15:22Z",
        "name": "string"
      },
      "categories": [
        {
          "categoryName": "string",
          "count": 0
        }
      ],
      "sampleSize": 0,
      "unknownCategoriesCount": 0,
      "value": 0
    }
  ],
  "metric": {
    "baselineValues": [
      {
        "value": 0
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "createdBy": {
      "id": "string"
    },
    "description": "string",
    "directionality": "higherIsBetter",
    "displayChart": true,
    "id": "string",
    "isModelSpecific": true,
    "name": "string",
    "sampleCount": {
      "columnName": "string"
    },
    "timeStep": "hour",
    "timestamp": {
      "columnName": "string",
      "timeFormat": "%m/%d/%Y"
    },
    "type": "average",
    "units": "string",
    "value": {
      "columnName": "string"
    }
  }
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Data retrieved successfully	MetricValuesOverBatchResponse
403	Forbidden	User does not have permission to read custom metric values.	None

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

BearerAuth

GET /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/valuesOverSpace/¶

Retrieve custom metric values over space.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
start	query	string(date-time)	false	Start of the period to retrieve monitoring stats, defaults to 7 days ago from the end of the period.
end	query	string(date-time)	false	End of the period to retrieve monitoring stats, defaults to the next top of the hour from now.
modelPackageId	query	string,null	false	The model package ID of related champion/challenger to retrieve custom metric values for.
modelId	query	string,null	false	The model ID of related champion/challenger to retrieve custom metric values for.
deploymentId	path	string	true	ID of the deployment
customMetricId	path	string	true	ID of the custom metric

Example responses¶


{
  "buckets": [
    {
      "categories": [
        {
          "categoryName": "string",
          "count": 0
        }
      ],
      "hexagon": "string",
      "sampleSize": 0,
      "unknownCategoriesCount": 0,
      "value": 0
    }
  ],
  "metric": {
    "baselineValues": [
      {
        "value": 0
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "createdBy": {
      "id": "string"
    },
    "description": "string",
    "directionality": "higherIsBetter",
    "displayChart": true,
    "id": "string",
    "isModelSpecific": true,
    "name": "string",
    "sampleCount": {
      "columnName": "string"
    },
    "timeStep": "hour",
    "timestamp": {
      "columnName": "string",
      "timeFormat": "%m/%d/%Y"
    },
    "type": "average",
    "units": "string",
    "value": {
      "columnName": "string"
    }
  },
  "modelId": "string",
  "modelPackageId": "string",
  "summary": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  }
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Custom metric values over space.	MetricValuesOverSpaceResponse
403	Forbidden	User does not have permission to read custom metric values.	None

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

BearerAuth

GET /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/valuesOverTime/¶

Retrieve custom metric values over time.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
start	query	string(date-time)	false	Start of the period to retrieve monitoring stats, defaults to 7 days ago from the end of the period.
end	query	string(date-time)	false	End of the period to retrieve monitoring stats, defaults to the next top of the hour from now.
modelPackageId	query	string,null	false	The model package ID of related champion/challenger to retrieve custom metric values for.
modelId	query	string,null	false	The model ID of related champion/challenger to retrieve custom metric values for.
bucketSize	query	string(duration)	false	Time duration of a bucket, default to seven days.
deploymentId	path	string	true	ID of the deployment
customMetricId	path	string	true	ID of the custom metric

Example responses¶


{
  "buckets": [
    {
      "categories": [
        {
          "categoryName": "string",
          "count": 0
        }
      ],
      "period": {
        "end": "2019-08-24T14:15:22Z",
        "start": "2019-08-24T14:15:22Z"
      },
      "sampleSize": 0,
      "unknownCategoriesCount": 0,
      "value": 0
    }
  ],
  "metric": {
    "baselineValues": [
      {
        "value": 0
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "createdBy": {
      "id": "string"
    },
    "description": "string",
    "directionality": "higherIsBetter",
    "displayChart": true,
    "id": "string",
    "isModelSpecific": true,
    "name": "string",
    "sampleCount": {
      "columnName": "string"
    },
    "timeStep": "hour",
    "timestamp": {
      "columnName": "string",
      "timeFormat": "%m/%d/%Y"
    },
    "type": "average",
    "units": "string",
    "value": {
      "columnName": "string"
    }
  },
  "summary": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  }
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Data retrieved successfully	MetricValuesOverTimeResponse
403	Forbidden	User does not have permission to read custom metric values.	None

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

BearerAuth

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

Retrieve the bulk summary of deployment batch custom metrics.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
start	query	string(date-time)	false	Start of the period to retrieve monitoring stats, defaults to 7 days ago from the end of the period.
end	query	string(date-time)	false	End of the period to retrieve monitoring stats, defaults to the next top of the hour from now.
modelPackageId	query	string,null	false	The model package ID of related champion/challenger to retrieve custom metric values for.
modelId	query	string,null	false	The model ID of related champion/challenger to retrieve custom metric values for.
batchId	query	any	false	The id of the batch for which metrics are being retrieved.
deploymentId	path	string	true	Unique identifier of the deployment.

Example responses¶


{
  "metrics": []
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Bulk summary retrieved successfully.	CustomMetricsBulkBatchSummary
403	Forbidden	User does not have permission to read the custom metrics summary.	None

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

BearerAuth

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

Retrieve the bulk summary of deployment custom metrics.

Code samples¶


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

Parameters

Name	In	Type	Required	Description
start	query	string(date-time)	false	Start of the period to retrieve monitoring stats, defaults to 7 days ago from the end of the period.
end	query	string(date-time)	false	End of the period to retrieve monitoring stats, defaults to the next top of the hour from now.
modelPackageId	query	string,null	false	The model package ID of related champion/challenger to retrieve custom metric values for.
modelId	query	string,null	false	The model ID of related champion/challenger to retrieve custom metric values for.
batchId	query	any	false	The id of the batch for which metrics are being retrieved.
deploymentId	path	string	true	Unique identifier of the deployment.

Example responses¶


{
  "details": {
    "earliestDate": "2019-08-24T14:15:22Z",
    "latestDate": "2019-08-24T14:15:22Z"
  },
  "metrics": [],
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  }
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Bulk summary retrieved successfully.	CustomMetricsBulkSummary
403	Forbidden	User does not have permission to read the custom metrics summary.	None

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

BearerAuth

Schemas¶

BatchField


{
  "columnName": "string"
}

A custom metric batch ID source when reading values from columnar dataset like a file.

Properties¶

Name	Type	Required	Restrictions	Description
columnName	string,null	true		Column name

BucketBatch


{
  "createdAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "lastPredictionTimestamp": "2019-08-24T14:15:22Z",
  "name": "string"
}

Describes a batch associated with the bucket.

Properties¶

Name	Type	Required	Description
createdAt	string(date-time)	true	Timestamp when the batch was created.
id	string	true	DataRobot assigned ID of the batch.
lastPredictionTimestamp	string(date-time)	false	Timestamp when the latest prediction request of the batch was made
name	string	true	User provided name of the batch.

CustomJobCustomMetricUpdate


{
  "baselineValues": [
    {
      "value": 0
    }
  ],
  "batch": {
    "columnName": "string"
  },
  "description": "string",
  "directionality": "higherIsBetter",
  "name": "string",
  "sampleCount": {
    "columnName": "string"
  },
  "schedule": {
    "dayOfMonth": [
      "*"
    ],
    "dayOfWeek": [
      "*"
    ],
    "hour": [
      "*"
    ],
    "minute": [
      "*"
    ],
    "month": [
      "*"
    ]
  },
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "type": "average",
  "units": "string",
  "value": {
    "columnName": "string"
  }
}

Properties¶

Name	Type	Required	Restrictions	Description
baselineValues	[MetricBaselineValue]	false	maxItems: 5	Baseline values
batch	BatchField	false		A custom metric batch ID source when reading values from columnar dataset like a file.
description	string	false	maxLength: 1000	A description of the custom metric.
directionality	string	false		Directionality of the custom metric.
name	string	false		Name of the custom metric.
sampleCount	SampleCountField	false		Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
schedule	Schedule	false		The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.
timestamp	MetricTimestampSpoofing	false		A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
type	string	false		Type (and aggregation character) of a metric.
units	string	false		Units or Y Label of given custom metric.
value	ValueField	false		A custom metric value source when reading values from columnar dataset like a file.

Enumerated Values¶

Property	Value
directionality	[`higherIsBetter`, `lowerIsBetter`]
type	[`average`, `categorical`, `gauge`, `sum`]

CustomJobFromGalleryTemplateCreate


{
  "description": "",
  "name": "string",
  "sidecarDeploymentId": "string",
  "templateId": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
description	string	false	maxLength: 1000	Description of the hosted custom metric job.
name	string	true	maxLength: 255	Name of the hosted custom metric job.
sidecarDeploymentId	string	false		Sidecar deployment ID.
templateId	string	true		Custom Metric Template ID.

CustomJobResources


{
  "egressNetworkPolicy": "none",
  "resourceBundleId": "string"
}

The custom job resources that will be applied in the k8s cluster.

Properties¶

Name	Type	Required	Restrictions	Description
egressNetworkPolicy	string	true		Egress network policy.
resourceBundleId	string,null	false		A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.

Enumerated Values¶

Property	Value
egressNetworkPolicy	[`none`, `public`]

CustomJobResponse


{
  "created": "string",
  "description": "string",
  "entryPoint": "string",
  "environmentId": "string",
  "environmentVersionId": "string",
  "id": "string",
  "items": [
    {
      "commitSha": "string",
      "created": "string",
      "fileName": "string",
      "filePath": "string",
      "fileSource": "string",
      "id": "string",
      "ref": "string",
      "repositoryFilePath": "string",
      "repositoryLocation": "string",
      "repositoryName": "string"
    }
  ],
  "jobType": "default",
  "lastRun": "string",
  "name": "string",
  "resources": {
    "egressNetworkPolicy": "none",
    "resourceBundleId": "string"
  },
  "runtimeParameters": [
    {
      "allowEmpty": true,
      "credentialType": "adlsGen2Oauth",
      "currentValue": "string",
      "defaultValue": "string",
      "description": "string",
      "fieldName": "string",
      "maxValue": 0,
      "minValue": 0,
      "overrideValue": "string",
      "type": "boolean"
    }
  ],
  "updated": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
created	string	true		ISO-8601 timestamp of when the custom job was created.
description	string	false	maxLength: 10000	The description of the custom job.
entryPoint	string,null	false		The ID of the entry point file to use.
environmentId	string,null	true		The ID of the execution environment used for this custom job.
environmentVersionId	string,null	true		The ID of the execution environment version used for this custom job.
id	string	true		The ID of the custom job.
items	[WorkspaceItemResponse]	true	maxItems: 1000	List of file items.
jobType	string	true		Type of the custom job.
lastRun	string,null	true		The last custom job run.
name	string	true		The name of the custom job.
resources	CustomJobResources	true		The custom job resources that will be applied in the k8s cluster.
runtimeParameters	[RuntimeParameterUnified]	false	maxItems: 100	Unified view of the defined runtime parameters for this custom job along with any values that are currently set that override the default value from their definition.
updated	string	true		ISO-8601 timestamp of when custom job was last updated.

Enumerated Values¶

Property	Value
jobType	[`default`, `hostedCustomMetric`, `notification`, `retraining`]

CustomMetricBatchSummary


{
  "metric": {
    "baselineValue": 0,
    "id": "string",
    "name": "string",
    "percentChange": 0,
    "sampleCount": 0,
    "unknownCategoriesCount": 0,
    "value": 0
  }
}

Properties¶

Name	Type	Required	Restrictions	Description
metric	MetricSummary	true		Summary of the custom metric.

CustomMetricDetails


{
  "earliestDate": "2019-08-24T14:15:22Z",
  "latestDate": "2019-08-24T14:15:22Z"
}

Additional information related to custom metrics.

Properties¶

Name	Type	Required	Restrictions	Description
earliestDate	string,null(date-time)	true		The earliest date of the custom metrics values.
latestDate	string,null(date-time)	true		The latest date of the custom metrics values.

CustomMetricOverSpaceBucket


{
  "categories": [
    {
      "categoryName": "string",
      "count": 0
    }
  ],
  "hexagon": "string",
  "sampleSize": 0,
  "unknownCategoriesCount": 0,
  "value": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
categories	[MetricCategory]	false	maxItems: 25	Aggregated custom metric categories in the bucket.
hexagon	string	true		h3 hexagon.
sampleSize	integer,null	false		Total number of values aggregated in the bucket.
unknownCategoriesCount	integer,null	false		The count of the values that do not correspond to the any of the known categories.
value	number,null	false		Aggregated custom metric value in the bucket.

CustomMetricSegmentDataset


{
  "column": "string",
  "name": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
column	string	true		Name of the column that contains segment values.
name	string	true		Name of the segment on which segment analysis is being performed.

CustomMetricSummary


{
  "metric": {
    "baselineValue": 0,
    "id": "string",
    "name": "string",
    "percentChange": 0,
    "sampleCount": 0,
    "unknownCategoriesCount": 0,
    "value": 0
  },
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  }
}

Properties¶

Name	Type	Required	Restrictions	Description
metric	MetricSummary	true		Summary of the custom metric.
period	MetricPeriodBucket	true		A time period defined by a start and end time

CustomMetricsBulkBatchSummary


{
  "metrics": []
}

Properties¶

Name	Type	Required	Restrictions	Description
metrics	[MetricSummary]	true	maxItems: 50	Custom metrics summaries.

CustomMetricsBulkSummary


{
  "details": {
    "earliestDate": "2019-08-24T14:15:22Z",
    "latestDate": "2019-08-24T14:15:22Z"
  },
  "metrics": [],
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  }
}

Properties¶

Name	Type	Required	Restrictions	Description
details	CustomMetricDetails	true		Additional information related to custom metrics.
metrics	[MetricSummary]	true	maxItems: 50	Custom metrics summaries.
period	MetricPeriodBucket	true		A time period defined by a start and end time

Deployment


{
  "createdAt": "2019-08-24T14:15:22Z",
  "creatorFirstName": "string",
  "creatorGravatarHash": "string",
  "creatorLastName": "string",
  "creatorUsername": "string",
  "id": "string",
  "name": "string"
}

The deployment associated to the custom metric.

Properties¶

Name	Type	Required	Description
createdAt	string(date-time)	true	Timestamp when the deployment was created.
creatorFirstName	string,null	true	First name of the deployment creator.
creatorGravatarHash	string,null	true	Gravatar hash of the deployment creator.
creatorLastName	string,null	true	Last name of the deployment creator.
creatorUsername	string,null	true	Username of the deployment creator.
id	string	true	The ID of the deployment.
name	string	true	Name of the deployment.

GeospatialCoordinateField


{
  "columnName": "string"
}

A custom metric geospatial coordinate source when reading values from columnar dataset like a file.

Properties¶

Name	Type	Required	Restrictions	Description
columnName	string,null	true		Column name

HostedCustomMetricTemplateCreate


{
  "directionality": "higherIsBetter",
  "isModelSpecific": true,
  "timeStep": "hour",
  "type": "average",
  "units": "string"
}

Properties¶

Name	Type	Required	Description
directionality	string,null	false	Directionality of the custom metric. This field is required for numeric custom metrics.
isModelSpecific	boolean	true	Determines whether the metric is related to the model or deployment.
timeStep	string	true	Custom metric time bucket size.
type	string	true	Type (and aggregation character) of a metric.
units	string,null	false	Units or the Y-axis label of the given custom metric. This field is required for numeric custom metrics.

Enumerated Values¶

Property	Value
directionality	[`higherIsBetter`, `lowerIsBetter`]
timeStep	`hour`
type	[`average`, `categorical`, `gauge`, `sum`]

HostedCustomMetricTemplateResponse


{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customJobId": "string",
  "directionality": "higherIsBetter",
  "id": "string",
  "isModelSpecific": true,
  "timeStep": "hour",
  "type": "average",
  "units": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

Properties¶

Name	Type	Required	Description
createdAt	string(date-time)	true	Hosted custom metric template creation timestamp.
createdBy	string	true	ID of the user who created the hosted custom metric template.
customJobId	string	true	ID of the associatedCustom job.
directionality	string,null	false	Directionality of the custom metric. This field is required for numeric custom metrics.
id	string	true	ID of the hosted custom metric template.
isModelSpecific	boolean	true	Determines whether the metric is related to the model or deployment.
timeStep	string	true	Custom metric time bucket size.
type	string	true	Type (and aggregation character) of a metric.
units	string,null	false	Units or the Y-axis label of the given custom metric. This field is required for numeric custom metrics.
updatedAt	string(date-time)	true	Hosted custom metric template update timestamp.
updatedBy	string	true	ID of the user who updated the hosted custom metric template.

Enumerated Values¶

Property	Value
directionality	[`higherIsBetter`, `lowerIsBetter`]
timeStep	`hour`
type	[`average`, `categorical`, `gauge`, `sum`]

HostedCustomMetricTemplateUpdate


{
  "directionality": "higherIsBetter",
  "isModelSpecific": true,
  "timeStep": "hour",
  "type": "average",
  "units": "string"
}

Properties¶

Name	Type	Required	Description
directionality	string	false	Directionality of the custom metric.
isModelSpecific	boolean	false	Determines whether the metric is related to the model or deployment.
timeStep	string	false	Custom metric time bucket size.
type	string	false	Type (and aggregation character) of a metric.
units	string	false	Units or Y Label of given custom metric.

Enumerated Values¶

Property	Value
directionality	[`higherIsBetter`, `lowerIsBetter`]
timeStep	`hour`
type	[`average`, `categorical`, `gauge`, `sum`]

MetricBaselineValue


{
  "value": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
value	number	true		A reference value in given metric units.

MetricCategory


{
  "categoryName": "string",
  "count": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
categoryName	string	true		Category value.
count	integer	true		Count of the categories in the bucket.

MetricCreateFromCustomJob


{
  "baselineValues": [
    {
      "value": 0
    }
  ],
  "customJobId": "string",
  "description": "",
  "name": "string",
  "sampleCount": {
    "columnName": "string"
  },
  "schedule": {
    "dayOfMonth": [
      "*"
    ],
    "dayOfWeek": [
      "*"
    ],
    "hour": [
      "*"
    ],
    "minute": [
      "*"
    ],
    "month": [
      "*"
    ]
  },
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "value": {
    "columnName": "string"
  }
}

Properties¶

Name	Type	Required	Restrictions	Description
baselineValues	[MetricBaselineValue]	false	maxItems: 5	Baseline values
customJobId	string	true		Custom Job ID.
description	string	false	maxLength: 1000	Description of the custom metric.
name	string	true	maxLength: 255	Name of the custom metric.
sampleCount	SampleCountField	false		Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
schedule	Schedule	false		The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.
timestamp	MetricTimestampSpoofing	false		A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
value	ValueField	false		A custom metric value source when reading values from columnar dataset like a file.

MetricCreateFromCustomJobResponse


{
  "baselineValues": [
    {
      "value": 0
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "deployment": {
    "createdAt": "2019-08-24T14:15:22Z",
    "creatorFirstName": "string",
    "creatorGravatarHash": "string",
    "creatorLastName": "string",
    "creatorUsername": "string",
    "id": "string",
    "name": "string"
  },
  "description": "",
  "directionality": "higherIsBetter",
  "id": "string",
  "isModelSpecific": true,
  "name": "string",
  "sampleCount": {
    "columnName": "string"
  },
  "schedule": {
    "dayOfMonth": [
      "*"
    ],
    "dayOfWeek": [
      "*"
    ],
    "hour": [
      "*"
    ],
    "minute": [
      "*"
    ],
    "month": [
      "*"
    ]
  },
  "timeStep": "hour",
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "type": "average",
  "units": "string",
  "value": {
    "columnName": "string"
  }
}

Properties¶

Name	Type	Required	Restrictions	Description
baselineValues	[MetricBaselineValue]	false	maxItems: 5	Baseline values
createdAt	string(date-time)	true		Hosted custom metric creation timestamp.
deployment	Deployment	true		The deployment associated to the custom metric.
description	string	false	maxLength: 1000	Description of the custom metric.
directionality	string,null	true		Directionality of the custom metric.
id	string	true		The ID of the custom metric.
isModelSpecific	boolean	true		Determines whether the metric is related to the model or deployment.
name	string	true	maxLength: 255	Name of the custom metric.
sampleCount	SampleCountField	false		Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
schedule	Schedule	false		The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.
timeStep	string	true		Custom metric time bucket size.
timestamp	MetricTimestampSpoofing	false		A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
type	string	true		Type (and aggregation character) of a metric.
units	string,null	true		Units or the Y-axis label of the given custom metric.
value	ValueField	false		A custom metric value source when reading values from columnar dataset like a file.

Enumerated Values¶

Property	Value
directionality	[`higherIsBetter`, `lowerIsBetter`]
timeStep	`hour`
type	[`average`, `categorical`, `gauge`, `sum`]

MetricCreatePayload


{
  "baselineValues": [
    {
      "value": 0
    }
  ],
  "description": "string",
  "directionality": "higherIsBetter",
  "isModelSpecific": true,
  "name": "string",
  "sampleCount": {
    "columnName": "string"
  },
  "timeStep": "hour",
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "type": "average",
  "units": "string",
  "value": {
    "columnName": "string"
  }
}

Properties¶

Name	Type	Required	Restrictions	Description
baselineValues	[MetricBaselineValue]	false	maxItems: 5	Baseline values. This field is required for numeric custom metrics.
description	string	false	maxLength: 1000	A description of the custom metric.
directionality	string,null	false		Directionality of the custom metric. This field is required for numeric custom metrics.
isModelSpecific	boolean	true		Determines whether the metric is related to the model or deployment.
name	string	true		Name of the custom metric.
sampleCount	SampleCountField	false		Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
timeStep	string	true		Custom metric time bucket size.
timestamp	MetricTimestampSpoofing	false		A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
type	string	true		Type (and aggregation character) of a metric.
units	string,null	false		Units or the Y-axis label of the given custom metric. This field is required for numeric custom metrics.
value	ValueField	false		A custom metric value source when reading values from columnar dataset like a file.

Enumerated Values¶

Property	Value
directionality	[`higherIsBetter`, `lowerIsBetter`]
timeStep	`hour`
type	[`average`, `categorical`, `gauge`, `sum`]

MetricCreatedBy


{
  "id": "string"
}

The user that created custom metric.

Properties¶

Name	Type	Required	Restrictions	Description
id	string	true		The ID of user who created custom metric.

MetricEntity


{
  "baselineValues": [
    {
      "value": 0
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string"
  },
  "description": "string",
  "directionality": "higherIsBetter",
  "displayChart": true,
  "id": "string",
  "isModelSpecific": true,
  "name": "string",
  "sampleCount": {
    "columnName": "string"
  },
  "timeStep": "hour",
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "type": "average",
  "units": "string",
  "value": {
    "columnName": "string"
  }
}

A custom metric definition.

Properties¶

Name	Type	Required	Restrictions	Description
baselineValues	[MetricBaselineValue]	false	maxItems: 5	Baseline values
createdAt	string(date-time)	true		Custom metric creation timestamp.
createdBy	MetricCreatedBy	true		The user that created custom metric.
description	string	false	maxLength: 1000	A description of the custom metric.
directionality	string,null	false		Directionality of the custom metric.
displayChart	boolean	false		Indicates if UI should show chart by default.
id	string	true		The ID of the custom metric.
isModelSpecific	boolean	true		Determines whether the metric is related to the model or deployment.
name	string	true		Name of the custom metric.
sampleCount	SampleCountField	false		Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
timeStep	string	true		Custom metric time bucket size.
timestamp	MetricTimestampSpoofing	false		A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
type	string	true		Type (and aggregation character) of a metric.
units	string,null	false		Units or Y Label of given custom metric.
value	ValueField	false		A custom metric value source when reading values from columnar dataset like a file.

Enumerated Values¶

Property	Value
directionality	[`higherIsBetter`, `lowerIsBetter`]
timeStep	`hour`
type	[`average`, `categorical`, `gauge`, `sum`]

MetricInputValueBucket


{
  "sampleSize": 1,
  "timestamp": "2019-08-24T14:15:22Z",
  "value": 0
}

Properties¶

Name	Type	Required	Description
sampleSize	integer	false	Custom metric value sample size.
timestamp	string,null(date-time)	false	Value timestamp.
value	any	true	Custom metric value to ingest.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	number	false		none

or

Name	Type	Required	Restrictions	Description
» anonymous	string	false		none

MetricListResponse


{
  "count": 0,
  "data": [
    {
      "baselineValues": [
        {
          "value": 0
        }
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": {
        "id": "string"
      },
      "description": "string",
      "directionality": "higherIsBetter",
      "displayChart": true,
      "id": "string",
      "isModelSpecific": true,
      "name": "string",
      "sampleCount": {
        "columnName": "string"
      },
      "timeStep": "hour",
      "timestamp": {
        "columnName": "string",
        "timeFormat": "%m/%d/%Y"
      },
      "type": "average",
      "units": "string",
      "value": {
        "columnName": "string"
      }
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true	minimum: 0	Number of paginated entries.
data	[MetricEntity]	true		A list of custom metrics.
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.

MetricPeriodBucket


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

A time period defined by a start and end time

Properties¶

Name	Type	Required	Restrictions	Description
end	string(date-time)	true		End of the bucket.
start	string(date-time)	true		Start of the bucket.

MetricSummary


{
  "baselineValue": 0,
  "id": "string",
  "name": "string",
  "percentChange": 0,
  "sampleCount": 0,
  "unknownCategoriesCount": 0,
  "value": 0
}

Summary of the custom metric.

Properties¶

Name	Type	Required	Description
baselineValue	number,null	false	Baseline value.
id	string	true	The ID of the custom metric.
name	string	true	Name of the custom metric.
percentChange	number,null	false	Percentage change of the baseline over its baseline.
sampleCount	integer,null	false	Number of samples used to calculate the aggregated value.
unknownCategoriesCount	number,null	false	Count of unknown categories for categorical metrics.
value	number,null	false	Aggregated value of the custom metric.

MetricTimestampSpoofing


{
  "columnName": "string",
  "timeFormat": "%m/%d/%Y"
}

A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.

Properties¶

Name	Type	Required	Restrictions	Description
columnName	string,null	false		Column name
timeFormat	string,null	false		Format

Enumerated Values¶

Property Value

timeFormat [%m/%d/%Y, %m/%d/%y, %d/%m/%y, %m-%d-%Y, %m-%d-%y, %Y/%m/%d, %Y-%m-%d, %Y-%m-%d %H:%M:%S, %Y/%m/%d %H:%M:%S, %Y.%m.%d %H:%M:%S, %Y-%m-%d %H:%M, %Y/%m/%d %H:%M, %y/%m/%d, %y-%m-%d, %y-%m-%d %H:%M:%S, %y.%m.%d %H:%M:%S, %y/%m/%d %H:%M:%S, %y-%m-%d %H:%M, %y.%m.%d %H:%M, %y/%m/%d %H:%M, %m/%d/%Y %H:%M, %m/%d/%y %H:%M, %d/%m/%Y %H:%M, %d/%m/%y %H:%M, %m-%d-%Y %H:%M, %m-%d-%y %H:%M, %d-%m-%Y %H:%M, %d-%m-%y %H:%M, %m.%d.%Y %H:%M, %m/%d.%y %H:%M, %d.%m.%Y %H:%M, %d.%m.%y %H:%M, %m/%d/%Y %H:%M:%S, %m/%d/%y %H:%M:%S, %m-%d-%Y %H:%M:%S, %m-%d-%y %H:%M:%S, %m.%d.%Y %H:%M:%S, %m.%d.%y %H:%M:%S, %d/%m/%Y %H:%M:%S, %d/%m/%y %H:%M:%S, %Y-%m-%d %H:%M:%S.%f, %y-%m-%d %H:%M:%S.%f, %Y-%m-%dT%H:%M:%S.%fZ, %y-%m-%dT%H:%M:%S.%fZ, %Y-%m-%dT%H:%M:%S.%f, %y-%m-%dT%H:%M:%S.%f, %Y-%m-%dT%H:%M:%S, %y-%m-%dT%H:%M:%S, %Y-%m-%dT%H:%M:%SZ, %y-%m-%dT%H:%M:%SZ, %Y.%m.%d %H:%M:%S.%f, %y.%m.%d %H:%M:%S.%f, %Y.%m.%dT%H:%M:%S.%fZ, %y.%m.%dT%H:%M:%S.%fZ, %Y.%m.%dT%H:%M:%S.%f, %y.%m.%dT%H:%M:%S.%f, %Y.%m.%dT%H:%M:%S, %y.%m.%dT%H:%M:%S, %Y.%m.%dT%H:%M:%SZ, %y.%m.%dT%H:%M:%SZ, %Y%m%d, %m %d %Y %H %M %S, %m %d %y %H %M %S, %H:%M, %M:%S, %H:%M:%S, %Y %m %d %H %M %S, %y %m %d %H %M %S, %Y %m %d, %y %m %d, %d/%m/%Y, %Y-%d-%m, %y-%d-%m, %Y/%d/%m %H:%M:%S.%f, %Y/%d/%m %H:%M:%S.%fZ, %Y/%m/%d %H:%M:%S.%f, %Y/%m/%d %H:%M:%S.%fZ, %y/%d/%m %H:%M:%S.%f, %y/%d/%m %H:%M:%S.%fZ, %y/%m/%d %H:%M:%S.%f, %y/%m/%d %H:%M:%S.%fZ, %m.%d.%Y, %m.%d.%y, %d.%m.%y, %d.%m.%Y, %Y.%m.%d, %Y.%d.%m, %y.%m.%d, %y.%d.%m, %Y-%m-%d %I:%M:%S %p, %Y/%m/%d %I:%M:%S %p, %Y.%m.%d %I:%M:%S %p, %Y-%m-%d %I:%M %p, %Y/%m/%d %I:%M %p, %y-%m-%d %I:%M:%S %p, %y.%m.%d %I:%M:%S %p, %y/%m/%d %I:%M:%S %p, %y-%m-%d %I:%M %p, %y.%m.%d %I:%M %p, %y/%m/%d %I:%M %p, %m/%d/%Y %I:%M %p, %m/%d/%y %I:%M %p, %d/%m/%Y %I:%M %p, %d/%m/%y %I:%M %p, %m-%d-%Y %I:%M %p, %m-%d-%y %I:%M %p, %d-%m-%Y %I:%M %p, %d-%m-%y %I:%M %p, %m.%d.%Y %I:%M %p, %m/%d.%y %I:%M %p, %d.%m.%Y %I:%M %p, %d.%m.%y %I:%M %p, %m/%d/%Y %I:%M:%S %p, %m/%d/%y %I:%M:%S %p, %m-%d-%Y %I:%M:%S %p, %m-%d-%y %I:%M:%S %p, %m.%d.%Y %I:%M:%S %p, %m.%d.%y %I:%M:%S %p, %d/%m/%Y %I:%M:%S %p, %d/%m/%y %I:%M:%S %p, %Y-%m-%d %I:%M:%S.%f %p, %y-%m-%d %I:%M:%S.%f %p, %Y-%m-%dT%I:%M:%S.%fZ %p, %y-%m-%dT%I:%M:%S.%fZ %p, %Y-%m-%dT%I:%M:%S.%f %p, %y-%m-%dT%I:%M:%S.%f %p, %Y-%m-%dT%I:%M:%S %p, %y-%m-%dT%I:%M:%S %p, %Y-%m-%dT%I:%M:%SZ %p, %y-%m-%dT%I:%M:%SZ %p, %Y.%m.%d %I:%M:%S.%f %p, %y.%m.%d %I:%M:%S.%f %p, %Y.%m.%dT%I:%M:%S.%fZ %p, %y.%m.%dT%I:%M:%S.%fZ %p, %Y.%m.%dT%I:%M:%S.%f %p, %y.%m.%dT%I:%M:%S.%f %p, %Y.%m.%dT%I:%M:%S %p, %y.%m.%dT%I:%M:%S %p, %Y.%m.%dT%I:%M:%SZ %p, %y.%m.%dT%I:%M:%SZ %p, %m %d %Y %I %M %S %p, %m %d %y %I %M %S %p, %I:%M %p, %I:%M:%S %p, %Y %m %d %I %M %S %p, %y %m %d %I %M %S %p, %Y/%d/%m %I:%M:%S.%f %p, %Y/%d/%m %I:%M:%S.%fZ %p, %Y/%m/%d %I:%M:%S.%f %p, %Y/%m/%d %I:%M:%S.%fZ %p, %y/%d/%m %I:%M:%S.%f %p, %y/%d/%m %I:%M:%S.%fZ %p, %y/%m/%d %I:%M:%S.%f %p, %y/%m/%d %I:%M:%S.%fZ %p]

MetricUpdatePayload


{
  "baselineValues": [
    {
      "value": 0
    }
  ],
  "batch": {
    "columnName": "string"
  },
  "description": "string",
  "directionality": "higherIsBetter",
  "name": "string",
  "sampleCount": {
    "columnName": "string"
  },
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "type": "average",
  "units": "string",
  "value": {
    "columnName": "string"
  }
}

Properties¶

Name	Type	Required	Restrictions	Description
baselineValues	[MetricBaselineValue]	false	maxItems: 5	Baseline values
batch	BatchField	false		A custom metric batch ID source when reading values from columnar dataset like a file.
description	string	false	maxLength: 1000	A description of the custom metric.
directionality	string	false		Directionality of the custom metric.
name	string	false		Name of the custom metric.
sampleCount	SampleCountField	false		Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
timestamp	MetricTimestampSpoofing	false		A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
type	string	false		Type (and aggregation character) of a metric.
units	string	false		Units or Y Label of given custom metric.
value	ValueField	false		A custom metric value source when reading values from columnar dataset like a file.

Enumerated Values¶

Property	Value
directionality	[`higherIsBetter`, `lowerIsBetter`]
type	[`average`, `categorical`, `gauge`, `sum`]

MetricValuesFromDatasetPayload


{
  "associationId": {
    "columnName": "string"
  },
  "batch": {
    "columnName": "string"
  },
  "datasetId": "string",
  "geospatial": {
    "columnName": "string"
  },
  "modelId": null,
  "modelPackageId": null,
  "sampleCount": {
    "columnName": "string"
  },
  "segments": [
    {
      "column": "string",
      "name": "string"
    }
  ],
  "timestamp": {
    "columnName": "string",
    "timeFormat": "%m/%d/%Y"
  },
  "value": {
    "columnName": "string"
  }
}

Properties¶

Name	Type	Required	Restrictions	Description
associationId	BatchField	false		A custom metric batch ID source when reading values from columnar dataset like a file.
batch	BatchField	false		A custom metric batch ID source when reading values from columnar dataset like a file.
datasetId	string	true		Dataset ID to process.
geospatial	GeospatialCoordinateField	false		A custom metric geospatial coordinate source when reading values from columnar dataset like a file.
modelId	string,null	false		For a model metric: the ID of the model of related champion/challenger to update the metric values.For a deployment metric: the ID of the model is not needed.
modelPackageId	string,null	false		For a model metric: the ID of the model package of related champion/challenger to update the metric values.For a deployment metric: the ID of the model package is not needed.
sampleCount	SampleCountField	false		Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
segments	[CustomMetricSegmentDataset]	false	maxItems: 10 minItems: 1	A list of segments for a custom metric used in segmented analysis. Cannot be used with geospatial custom metrics.
timestamp	MetricTimestampSpoofing	false		A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
value	ValueField	false		A custom metric value source when reading values from columnar dataset like a file.

MetricValuesFromJSONPayload


{
  "buckets": [
    {
      "sampleSize": 1,
      "timestamp": "2019-08-24T14:15:22Z",
      "value": 0
    }
  ],
  "dryRun": false,
  "modelId": null,
  "modelPackageId": null
}

Properties¶

Name	Type	Required	Restrictions	Description
buckets	[MetricInputValueBucket]	true	maxItems: 10000	A list of timestamped buckets with custom metric values.
dryRun	boolean	true		Determines if the custom metric data calculated for this run is saved to the database.
modelId	string,null	false		For a model metric: the ID of the model of related champion/challenger to update the metric values.For a deployment metric: the ID of the model is not needed.
modelPackageId	string,null	false		For a model metric: the ID of the model package of related champion/challenger to update the metric values.For a deployment metric: the ID of the model package is not needed.

MetricValuesOverBatchBucket


{
  "batch": {
    "createdAt": "2019-08-24T14:15:22Z",
    "id": "string",
    "lastPredictionTimestamp": "2019-08-24T14:15:22Z",
    "name": "string"
  },
  "categories": [
    {
      "categoryName": "string",
      "count": 0
    }
  ],
  "sampleSize": 0,
  "unknownCategoriesCount": 0,
  "value": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
batch	BucketBatch	true		Describes a batch associated with the bucket.
categories	[MetricCategory]	false	maxItems: 25	Aggregated custom metric categories in the bucket.
sampleSize	integer,null	false		Total number of values aggregated in the bucket.
unknownCategoriesCount	integer,null	false		The count of the values that do not correspond to the any of the known categories.
value	number,null	false		Aggregated custom metric value in the bucket.

MetricValuesOverBatchResponse


{
  "buckets": [
    {
      "batch": {
        "createdAt": "2019-08-24T14:15:22Z",
        "id": "string",
        "lastPredictionTimestamp": "2019-08-24T14:15:22Z",
        "name": "string"
      },
      "categories": [
        {
          "categoryName": "string",
          "count": 0
        }
      ],
      "sampleSize": 0,
      "unknownCategoriesCount": 0,
      "value": 0
    }
  ],
  "metric": {
    "baselineValues": [
      {
        "value": 0
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "createdBy": {
      "id": "string"
    },
    "description": "string",
    "directionality": "higherIsBetter",
    "displayChart": true,
    "id": "string",
    "isModelSpecific": true,
    "name": "string",
    "sampleCount": {
      "columnName": "string"
    },
    "timeStep": "hour",
    "timestamp": {
      "columnName": "string",
      "timeFormat": "%m/%d/%Y"
    },
    "type": "average",
    "units": "string",
    "value": {
      "columnName": "string"
    }
  }
}

Properties¶

Name	Type	Required	Restrictions	Description
buckets	[MetricValuesOverBatchBucket]	true	maxItems: 100	A list of bucketed batches and the custom metric values aggregated over that batches.
metric	MetricEntity	true		A custom metric definition.

MetricValuesOverSpaceResponse


{
  "buckets": [
    {
      "categories": [
        {
          "categoryName": "string",
          "count": 0
        }
      ],
      "hexagon": "string",
      "sampleSize": 0,
      "unknownCategoriesCount": 0,
      "value": 0
    }
  ],
  "metric": {
    "baselineValues": [
      {
        "value": 0
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "createdBy": {
      "id": "string"
    },
    "description": "string",
    "directionality": "higherIsBetter",
    "displayChart": true,
    "id": "string",
    "isModelSpecific": true,
    "name": "string",
    "sampleCount": {
      "columnName": "string"
    },
    "timeStep": "hour",
    "timestamp": {
      "columnName": "string",
      "timeFormat": "%m/%d/%Y"
    },
    "type": "average",
    "units": "string",
    "value": {
      "columnName": "string"
    }
  },
  "modelId": "string",
  "modelPackageId": "string",
  "summary": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  }
}

Properties¶

Name	Type	Required	Restrictions	Description
buckets	[CustomMetricOverSpaceBucket]	true	maxItems: 1000	A list of buckets containing aggregated custom metric values.
metric	MetricEntity	true		A custom metric definition.
modelId	string	false		The ID of the model for which metrics are being retrieved.
modelPackageId	string,null	false		The ID of the model package for which metrics are being retrieved.
summary	MetricValuesOverTimeSummary	true		Summary of values over time retrieval.

MetricValuesOverTimeBucket


{
  "categories": [
    {
      "categoryName": "string",
      "count": 0
    }
  ],
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  },
  "sampleSize": 0,
  "unknownCategoriesCount": 0,
  "value": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
categories	[MetricCategory]	false	maxItems: 25	Aggregated custom metric categories in the bucket.
period	MetricPeriodBucket	true		A time period defined by a start and end time
sampleSize	integer,null	false		Total number of values aggregated in the bucket.
unknownCategoriesCount	integer,null	false		The count of the values that do not correspond to the any of the known categories.
value	number,null	false		Aggregated custom metric value in the bucket.

MetricValuesOverTimeResponse


{
  "buckets": [
    {
      "categories": [
        {
          "categoryName": "string",
          "count": 0
        }
      ],
      "period": {
        "end": "2019-08-24T14:15:22Z",
        "start": "2019-08-24T14:15:22Z"
      },
      "sampleSize": 0,
      "unknownCategoriesCount": 0,
      "value": 0
    }
  ],
  "metric": {
    "baselineValues": [
      {
        "value": 0
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "createdBy": {
      "id": "string"
    },
    "description": "string",
    "directionality": "higherIsBetter",
    "displayChart": true,
    "id": "string",
    "isModelSpecific": true,
    "name": "string",
    "sampleCount": {
      "columnName": "string"
    },
    "timeStep": "hour",
    "timestamp": {
      "columnName": "string",
      "timeFormat": "%m/%d/%Y"
    },
    "type": "average",
    "units": "string",
    "value": {
      "columnName": "string"
    }
  },
  "summary": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  }
}

Properties¶

Name	Type	Required	Restrictions	Description
buckets	[MetricValuesOverTimeBucket]	true	maxItems: 100	A list of bucketed time periods and the custom metric values aggregated over that period.
metric	MetricEntity	true		A custom metric definition.
summary	MetricValuesOverTimeSummary	true		Summary of values over time retrieval.

MetricValuesOverTimeSummary


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

Summary of values over time retrieval.

Properties¶

Name	Type	Required	Restrictions	Description
end	string(date-time)	true		End of the retrieval range.
start	string(date-time)	true		Start of the retrieval range.

RuntimeParameterUnified


{
  "allowEmpty": true,
  "credentialType": "adlsGen2Oauth",
  "currentValue": "string",
  "defaultValue": "string",
  "description": "string",
  "fieldName": "string",
  "maxValue": 0,
  "minValue": 0,
  "overrideValue": "string",
  "type": "boolean"
}

Properties¶

Name	Type	Required	Description
allowEmpty	boolean	false	Indicates whether the param must be set before registration
credentialType	string,null	false	The type of credential, required only for credentials parameters.
currentValue	any	false	Given the default and the override, this is the actual current value of the parameter.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		none

or

Name	Type	Required	Restrictions	Description
» anonymous	number	false		none

or

Name	Type	Required	Restrictions	Description
» anonymous	boolean	false		none

continued

Name	Type	Required	Restrictions	Description
defaultValue	any	false		The default value for the given field.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		none

or

Name	Type	Required	Restrictions	Description
» anonymous	number	false		none

or

Name	Type	Required	Restrictions	Description
» anonymous	boolean	false		none

continued

Name	Type	Required	Description
description	string,null	false	Description how this parameter impacts the running model.
fieldName	string	true	The parameter name. This value will be added as an environment variable when running custom models.
maxValue	number,null	false	The maximum value for a numeric field.
minValue	number,null	false	The minimum value for a numeric field.
overrideValue	any	false	Value set by the user that overrides the default set in the definition.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		none

or

Name	Type	Required	Restrictions	Description
» anonymous	number	false		none

or

Name	Type	Required	Restrictions	Description
» anonymous	boolean	false		none

continued

Name	Type	Required	Restrictions	Description
type	string	true		The type of this value.

Enumerated Values¶

Property	Value
credentialType	[`adlsGen2Oauth`, `apiToken`, `azure`, `azureServicePrincipal`, `basic`, `bearer`, `databricksAccessTokenAccount`, `databricksServicePrincipalAccount`, `gcp`, `oauth`, `rsa`, `s3`, `sapOauth`, `snowflakeKeyPairUserAccount`, `snowflakeOauthUserAccount`, `tableauAccessToken`]
type	[`boolean`, `credential`, `customMetric`, `deployment`, `modelPackage`, `numeric`, `string`]

SampleCountField


{
  "columnName": "string"
}

Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.

Properties¶

Name	Type	Required	Restrictions	Description
columnName	string,null	true		Column name

Schedule


{
  "dayOfMonth": [
    "*"
  ],
  "dayOfWeek": [
    "*"
  ],
  "hour": [
    "*"
  ],
  "minute": [
    "*"
  ],
  "month": [
    "*"
  ]
}

The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.

Properties¶

Name	Type	Required	Restrictions	Description
dayOfMonth	[number,string]	true	maxItems: 31	The date(s) of the month that the job will run. Allowed values are either `[1 ... 31]` or `[""]` for all days of the month. This field is additive with `dayOfWeek`, meaning the job will run both on the date(s) defined in this field and the day specified by `dayOfWeek` (for example, dates 1st, 2nd, 3rd, plus every Tuesday). If `dayOfMonth` is set to `[""]` and `dayOfWeek` is defined, the scheduler will trigger on every day of the month that matches `dayOfWeek` (for example, Tuesday the 2nd, 9th, 16th, 23rd, 30th). Invalid dates such as February 31st are ignored.
dayOfWeek	[number,string]	true	maxItems: 7	The day(s) of the week that the job will run. Allowed values are `[0 .. 6]`, where (Sunday=0), or `["*"]`, for all days of the week. Strings, either 3-letter abbreviations or the full name of the day, can be used interchangeably (e.g., "sunday", "Sunday", "sun", or "Sun", all map to `[0]`. This field is additive with `dayOfMonth`, meaning the job will run both on the date specified by `dayOfMonth` and the day defined in this field.
hour	[number,string]	true	maxItems: 24	The hour(s) of the day that the job will run. Allowed values are either `["*"]` meaning every hour of the day or `[0 ... 23]`.
minute	[number,string]	true	maxItems: 60	The minute(s) of the day that the job will run. Allowed values are either `["*"]` meaning every minute of the day or`[0 ... 59]`.
month	[number,string]	true	maxItems: 12	The month(s) of the year that the job will run. Allowed values are either `[1 ... 12]` or `["*"]` for all months of the year. Strings, either 3-letter abbreviations or the full name of the month, can be used interchangeably (e.g., "jan" or "october"). Months that are not compatible with `dayOfMonth` are ignored, for example `{"dayOfMonth": [31], "month":["feb"]}`.

ValueField


{
  "columnName": "string"
}

A custom metric value source when reading values from columnar dataset like a file.

Properties¶

Name	Type	Required	Restrictions	Description
columnName	string,null	true		Column name

WorkspaceItemResponse


{
  "commitSha": "string",
  "created": "string",
  "fileName": "string",
  "filePath": "string",
  "fileSource": "string",
  "id": "string",
  "ref": "string",
  "repositoryFilePath": "string",
  "repositoryLocation": "string",
  "repositoryName": "string"
}

Properties¶

Name	Type	Required	Description
commitSha	string,null	false	SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).
created	string	true	ISO-8601 timestamp of when the file item was created.
fileName	string	true	Name of the file item.
filePath	string	true	Path of the file item.
fileSource	string	true	Source of the file item.
id	string	true	ID of the file item.
ref	string,null	false	Remote reference (branch, commit, tag). Branch "master", if not specified.
repositoryFilePath	string,null	false	Full path to the file in the remote repository.
repositoryLocation	string,null	false	URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).
repositoryName	string,null	false	Name of the repository from which the file was pulled.