Custom metrics
Use the endpoints described below to manage custom metrics. Use the data you collect from data exploration (or data calculated through other custom metrics) to compute and monitor custom business or performance metrics. This feature allows you to implement your organization's specialized metrics, expanding on the insights provided by DataRobot's built-in service health, data drift, and accuracy metrics.
POST /api/v2/customJobs/fromHostedCustomMetricGalleryTemplate/
Creates a custom job from the hosted custom metric template.
Body parameter
{
"properties": {
"description": {
"default": "",
"description": "Description of the hosted custom metric job.",
"maxLength": 1000,
"type": "string"
},
"name": {
"description": "Name of the hosted custom metric job.",
"maxLength": 255,
"type": "string"
},
"sidecarDeploymentId": {
"description": "Sidecar deployment ID.",
"type": "string"
},
"templateId": {
"description": "Custom Metric Template ID.",
"type": "string"
}
},
"required": [
"name",
"templateId"
],
"type": "object",
"x-versionadded": "v2.34"
}
Parameters
Example responses
201 Response
{
"properties": {
"created": {
"description": "ISO-8601 timestamp of when the custom job was created.",
"type": "string",
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the custom job.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"entryPoint": {
"description": "The ID of the entry point file to use.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentId": {
"description": "The ID of the execution environment used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentVersionId": {
"description": "The ID of the execution environment version used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"jobType": {
"description": "Type of the custom job.",
"enum": [
"default",
"hostedCustomMetric",
"notification",
"retraining"
],
"type": "string",
"x-versionadded": "v2.33"
},
"lastRun": {
"description": "The last custom job run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "The name of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "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.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameters": {
"description": "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.",
"items": {
"properties": {
"allowEmpty": {
"default": true,
"description": "Indicates whether the param must be set before registration",
"type": "boolean",
"x-versionadded": "v2.33"
},
"credentialType": {
"description": "The type of credential, required only for credentials parameters.",
"enum": [
"adlsGen2Oauth",
"apiToken",
"azure",
"azureServicePrincipal",
"basic",
"bearer",
"databricksAccessTokenAccount",
"databricksServicePrincipalAccount",
"gcp",
"oauth",
"rsa",
"s3",
"sapOauth",
"snowflakeKeyPairUserAccount",
"snowflakeOauthUserAccount",
"tableauAccessToken"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"currentValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Given the default and the override, this is the actual current value of the parameter.",
"x-versionadded": "v2.33"
},
"defaultValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "The default value for the given field.",
"x-versionadded": "v2.33"
},
"description": {
"description": "Description how this parameter impacts the running model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"fieldName": {
"description": "The parameter name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"maxValue": {
"description": "The maximum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"minValue": {
"description": "The minimum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"overrideValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Value set by the user that overrides the default set in the definition.",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"updated": {
"description": "ISO-8601 timestamp of when custom job was last updated.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"created",
"environmentId",
"environmentVersionId",
"id",
"items",
"jobType",
"lastRun",
"name",
"resources",
"updated"
],
"type": "object"
}
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.
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
201 Response
{
"properties": {
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Values of the categories. This field is required for categorical custom metrics.",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Hosted custom metric creation timestamp.",
"format": "date-time",
"type": "string"
},
"deployment": {
"description": "The deployment associated to the custom metric.",
"properties": {
"createdAt": {
"description": "Timestamp when the deployment was created.",
"format": "date-time",
"type": "string"
},
"creatorFirstName": {
"description": "First name of the deployment creator.",
"type": [
"string",
"null"
]
},
"creatorGravatarHash": {
"description": "Gravatar hash of the deployment creator.",
"type": [
"string",
"null"
]
},
"creatorLastName": {
"description": "Last name of the deployment creator.",
"type": [
"string",
"null"
]
},
"creatorUsername": {
"description": "Username of the deployment creator.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the deployment.",
"type": "string"
},
"name": {
"description": "Name of the deployment.",
"type": "string"
}
},
"required": [
"createdAt",
"creatorFirstName",
"creatorGravatarHash",
"creatorLastName",
"creatorUsername",
"id",
"name"
],
"type": "object",
"x-versionadded": "v2.34"
},
"description": {
"default": "",
"description": "Description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"geospatialSegmentAttribute": {
"description": "Name of the column that contains geospatial values.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"isGeospatial": {
"description": "Determines whether the metric is geospatial.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"name": {
"description": "Name of the custom metric.",
"maxLength": 255,
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "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.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "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.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "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\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"timeStep": {
"default": "hour",
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or the Y-axis label of the given custom metric.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"createdAt",
"deployment",
"directionality",
"id",
"isModelSpecific",
"name",
"timeStep",
"type",
"units"
],
"type": "object",
"x-versionadded": "v2.34"
}
Responses
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.
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.
Body parameter
{
"properties": {
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"batch": {
"description": "A custom metric batch ID source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"categories": {
"description": "Category values. This field is required for categorical custom metrics.",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "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.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "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.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "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\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": "string"
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"type": "object",
"x-versionadded": "v2.34"
}
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
200 Response
{
"properties": {
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Values of the categories. This field is required for categorical custom metrics.",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Hosted custom metric creation timestamp.",
"format": "date-time",
"type": "string"
},
"deployment": {
"description": "The deployment associated to the custom metric.",
"properties": {
"createdAt": {
"description": "Timestamp when the deployment was created.",
"format": "date-time",
"type": "string"
},
"creatorFirstName": {
"description": "First name of the deployment creator.",
"type": [
"string",
"null"
]
},
"creatorGravatarHash": {
"description": "Gravatar hash of the deployment creator.",
"type": [
"string",
"null"
]
},
"creatorLastName": {
"description": "Last name of the deployment creator.",
"type": [
"string",
"null"
]
},
"creatorUsername": {
"description": "Username of the deployment creator.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the deployment.",
"type": "string"
},
"name": {
"description": "Name of the deployment.",
"type": "string"
}
},
"required": [
"createdAt",
"creatorFirstName",
"creatorGravatarHash",
"creatorLastName",
"creatorUsername",
"id",
"name"
],
"type": "object",
"x-versionadded": "v2.34"
},
"description": {
"default": "",
"description": "Description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"geospatialSegmentAttribute": {
"description": "Name of the column that contains geospatial values.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"isGeospatial": {
"description": "Determines whether the metric is geospatial.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"name": {
"description": "Name of the custom metric.",
"maxLength": 255,
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "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.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "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.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "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\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"timeStep": {
"default": "hour",
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or the Y-axis label of the given custom metric.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"createdAt",
"deployment",
"directionality",
"id",
"isModelSpecific",
"name",
"timeStep",
"type",
"units"
],
"type": "object",
"x-versionadded": "v2.34"
}
Responses
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.
Parameters
| Name |
In |
Type |
Required |
Description |
| customJobId |
path |
string |
true |
ID of the custom job. |
Example responses
200 Response
{
"properties": {
"categories": {
"description": "Values of the categories. This field is required for categorical custom metrics.",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Hosted custom metric template creation timestamp.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "ID of the user who created the hosted custom metric template.",
"type": "string"
},
"customJobId": {
"description": "ID of the associatedCustom job.",
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric. This field is required for numeric custom metrics.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the hosted custom metric template.",
"type": "string"
},
"isGeospatial": {
"description": "Determines whether the metric is geospatial.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"timeStep": {
"default": "hour",
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or the Y-axis label of the given custom metric. This field is required for numeric custom metrics.",
"type": [
"string",
"null"
]
},
"updatedAt": {
"description": "Hosted custom metric template update timestamp.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "ID of the user who updated the hosted custom metric template.",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"customJobId",
"id",
"isModelSpecific",
"timeStep",
"type",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.34"
}
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.
Body parameter
{
"properties": {
"categories": {
"description": "Values of the categories. This field is required for categorical custom metrics.",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"isGeospatial": {
"description": "Determines whether the metric is geospatial.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"timeStep": {
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": "string"
}
},
"type": "object",
"x-versionadded": "v2.34"
}
Parameters
Example responses
201 Response
{
"properties": {
"categories": {
"description": "Values of the categories. This field is required for categorical custom metrics.",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Hosted custom metric template creation timestamp.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "ID of the user who created the hosted custom metric template.",
"type": "string"
},
"customJobId": {
"description": "ID of the associatedCustom job.",
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric. This field is required for numeric custom metrics.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the hosted custom metric template.",
"type": "string"
},
"isGeospatial": {
"description": "Determines whether the metric is geospatial.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"timeStep": {
"default": "hour",
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or the Y-axis label of the given custom metric. This field is required for numeric custom metrics.",
"type": [
"string",
"null"
]
},
"updatedAt": {
"description": "Hosted custom metric template update timestamp.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "ID of the user who updated the hosted custom metric template.",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"customJobId",
"id",
"isModelSpecific",
"timeStep",
"type",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.34"
}
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.
Body parameter
{
"properties": {
"categories": {
"description": "Values of the categories. This field is required for categorical custom metrics.",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"directionality": {
"description": "Directionality of the custom metric. This field is required for numeric custom metrics.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"isGeospatial": {
"description": "Determines whether the metric is geospatial.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"timeStep": {
"default": "hour",
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or the Y-axis label of the given custom metric. This field is required for numeric custom metrics.",
"type": [
"string",
"null"
]
}
},
"required": [
"isModelSpecific",
"timeStep",
"type"
],
"type": "object",
"x-versionadded": "v2.34"
}
Parameters
Example responses
201 Response
{
"properties": {
"categories": {
"description": "Values of the categories. This field is required for categorical custom metrics.",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Hosted custom metric template creation timestamp.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "ID of the user who created the hosted custom metric template.",
"type": "string"
},
"customJobId": {
"description": "ID of the associatedCustom job.",
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric. This field is required for numeric custom metrics.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the hosted custom metric template.",
"type": "string"
},
"isGeospatial": {
"description": "Determines whether the metric is geospatial.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"timeStep": {
"default": "hour",
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or the Y-axis label of the given custom metric. This field is required for numeric custom metrics.",
"type": [
"string",
"null"
]
},
"updatedAt": {
"description": "Hosted custom metric template update timestamp.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "ID of the user who updated the hosted custom metric template.",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"customJobId",
"id",
"isModelSpecific",
"timeStep",
"type",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.34"
}
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.
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
200 Response
{
"properties": {
"count": {
"description": "Number of paginated entries.",
"minimum": 0,
"type": "integer"
},
"data": {
"description": "A list of custom metrics.",
"items": {
"description": "A custom metric definition.",
"properties": {
"associationId": {
"description": "A custom metric associationId source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Category values",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Custom metric creation timestamp.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The user that created custom metric.",
"properties": {
"id": {
"description": "The ID of user who created custom metric.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"displayChart": {
"description": "Indicates if UI should show chart by default.",
"type": "boolean"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"metadata": {
"description": "A custom metric metadata source when reading values from columnar datasets like a file.",
"properties": {
"columnName": {
"description": "Column name",
"maxLength": 128,
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"timeStep": {
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"isModelSpecific",
"name",
"timeStep",
"type"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL to the next page, or null if there is no such page",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL to the previous page, or null if there is no such page",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "Total number of entries.",
"minimum": 0,
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
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.
Body parameter
{
"properties": {
"baselineValues": {
"description": "Baseline values. This field is required for numeric custom metrics.",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Values of the categories. This field is required for categorical custom metrics.",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric. This field is required for numeric custom metrics.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"timeStep": {
"default": "hour",
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or the Y-axis label of the given custom metric. This field is required for numeric custom metrics.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"isModelSpecific",
"name",
"timeStep",
"type"
],
"type": "object"
}
Parameters
| Name |
In |
Type |
Required |
Description |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
| body |
body |
MetricCreatePayload |
false |
none |
Example responses
201 Response
{
"description": "A custom metric definition.",
"properties": {
"associationId": {
"description": "A custom metric associationId source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Category values",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Custom metric creation timestamp.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The user that created custom metric.",
"properties": {
"id": {
"description": "The ID of user who created custom metric.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"displayChart": {
"description": "Indicates if UI should show chart by default.",
"type": "boolean"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"metadata": {
"description": "A custom metric metadata source when reading values from columnar datasets like a file.",
"properties": {
"columnName": {
"description": "Column name",
"maxLength": 128,
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"timeStep": {
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"isModelSpecific",
"name",
"timeStep",
"type"
],
"type": "object"
}
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.
Body parameter
{
"properties": {
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"customJobId": {
"description": "Custom Job ID.",
"type": "string"
},
"description": {
"default": "",
"description": "Description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"geospatialSegmentAttribute": {
"description": "Name of the column that contains geospatial values.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"name": {
"description": "Name of the custom metric.",
"maxLength": 255,
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "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.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "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.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "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\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"customJobId",
"name"
],
"type": "object",
"x-versionadded": "v2.34"
}
Parameters
| Name |
In |
Type |
Required |
Description |
| deploymentId |
path |
string |
true |
Unique identifier of the deployment. |
| body |
body |
MetricCreateFromCustomJob |
false |
none |
Example responses
201 Response
{
"properties": {
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Values of the categories. This field is required for categorical custom metrics.",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Hosted custom metric creation timestamp.",
"format": "date-time",
"type": "string"
},
"deployment": {
"description": "The deployment associated to the custom metric.",
"properties": {
"createdAt": {
"description": "Timestamp when the deployment was created.",
"format": "date-time",
"type": "string"
},
"creatorFirstName": {
"description": "First name of the deployment creator.",
"type": [
"string",
"null"
]
},
"creatorGravatarHash": {
"description": "Gravatar hash of the deployment creator.",
"type": [
"string",
"null"
]
},
"creatorLastName": {
"description": "Last name of the deployment creator.",
"type": [
"string",
"null"
]
},
"creatorUsername": {
"description": "Username of the deployment creator.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the deployment.",
"type": "string"
},
"name": {
"description": "Name of the deployment.",
"type": "string"
}
},
"required": [
"createdAt",
"creatorFirstName",
"creatorGravatarHash",
"creatorLastName",
"creatorUsername",
"id",
"name"
],
"type": "object",
"x-versionadded": "v2.34"
},
"description": {
"default": "",
"description": "Description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"geospatialSegmentAttribute": {
"description": "Name of the column that contains geospatial values.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"isGeospatial": {
"description": "Determines whether the metric is geospatial.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"name": {
"description": "Name of the custom metric.",
"maxLength": 255,
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "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.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "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.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "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\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"timeStep": {
"default": "hour",
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or the Y-axis label of the given custom metric.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"createdAt",
"deployment",
"directionality",
"id",
"isModelSpecific",
"name",
"timeStep",
"type",
"units"
],
"type": "object",
"x-versionadded": "v2.34"
}
Responses
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.
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.
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
200 Response
{
"description": "A custom metric definition.",
"properties": {
"associationId": {
"description": "A custom metric associationId source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Category values",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Custom metric creation timestamp.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The user that created custom metric.",
"properties": {
"id": {
"description": "The ID of user who created custom metric.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"displayChart": {
"description": "Indicates if UI should show chart by default.",
"type": "boolean"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"metadata": {
"description": "A custom metric metadata source when reading values from columnar datasets like a file.",
"properties": {
"columnName": {
"description": "Column name",
"maxLength": 128,
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"timeStep": {
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"isModelSpecific",
"name",
"timeStep",
"type"
],
"type": "object"
}
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.
Body parameter
{
"properties": {
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"batch": {
"description": "A custom metric batch ID source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"categories": {
"description": "Category values. This field is required for categorical custom metrics.",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": "string"
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"type": "object"
}
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
200 Response
{
"description": "A custom metric definition.",
"properties": {
"associationId": {
"description": "A custom metric associationId source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Category values",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Custom metric creation timestamp.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The user that created custom metric.",
"properties": {
"id": {
"description": "The ID of user who created custom metric.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"displayChart": {
"description": "Indicates if UI should show chart by default.",
"type": "boolean"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"metadata": {
"description": "A custom metric metadata source when reading values from columnar datasets like a file.",
"properties": {
"columnName": {
"description": "Column name",
"maxLength": 128,
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"timeStep": {
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"isModelSpecific",
"name",
"timeStep",
"type"
],
"type": "object"
}
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.
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. |
| segmentAttribute |
query |
string |
false |
The name of the segment on which segment analysis is being performed. |
| segmentValue |
query |
string |
false |
The value of the segmentAttribute to segment on. |
| 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
200 Response
{
"properties": {
"metric": {
"description": "Summary of the custom metric.",
"properties": {
"baselineValue": {
"description": "Baseline value.",
"type": [
"number",
"null"
]
},
"categories": {
"description": "Category values.",
"items": {
"properties": {
"baselineValue": {
"description": "A reference value for the current category count.",
"type": [
"number",
"null"
]
},
"categoryName": {
"description": "Category value",
"type": "string"
},
"percentChange": {
"description": "Percent change when compared with the reference value.",
"type": [
"number",
"null"
]
},
"value": {
"description": "A value for the current category count.",
"type": [
"number",
"null"
]
}
},
"required": [
"categoryName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"percentChange": {
"description": "Percentage change of the baseline over its baseline.",
"type": [
"number",
"null"
]
},
"sampleCount": {
"description": "Number of samples used to calculate the aggregated value.",
"type": [
"integer",
"null"
]
},
"unknownCategoriesCount": {
"description": "Count of unknown categories for categorical metrics.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.35"
},
"value": {
"description": "Aggregated value of the custom metric.",
"type": [
"number",
"null"
]
}
},
"required": [
"id",
"name"
],
"type": "object"
}
},
"required": [
"metric"
],
"type": "object"
}
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.
Body parameter
{
"properties": {
"associationId": {
"description": "A custom metric batch ID source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"batch": {
"description": "A custom metric batch ID source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"datasetId": {
"description": "Dataset ID to process.",
"type": "string"
},
"geospatial": {
"description": "A custom metric geospatial coordinate source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"modelId": {
"default": null,
"description": "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.",
"type": [
"string",
"null"
]
},
"modelPackageId": {
"default": null,
"description": "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.",
"type": [
"string",
"null"
]
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"segments": {
"description": "A list of segments for a custom metric used in segmented analysis. Cannot be used with geospatial custom metrics.",
"items": {
"properties": {
"column": {
"description": "Name of the column that contains segment values.",
"type": "string"
},
"name": {
"description": "Name of the segment on which segment analysis is being performed.",
"type": "string"
}
},
"required": [
"column",
"name"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"datasetId"
],
"type": "object"
}
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.
Body parameter
{
"properties": {
"buckets": {
"description": "A list of timestamped buckets with custom metric values.",
"items": {
"properties": {
"associationId": {
"default": null,
"description": "Identifies prediction row corresponding to value.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"geospatialCoordinate": {
"description": "A geospatial object in WKB or WKT format. Only required for geospatial custom metrics.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.36"
},
"metadata": {
"default": null,
"description": "A read-only metadata association with a custom metric value.",
"maxLength": 128,
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"sampleSize": {
"default": 1,
"description": "Custom metric value sample size.",
"type": "integer"
},
"segments": {
"description": "A list of segments for a custom metric used in segmented analysis. Segments cannot be provided for geospatial metrics.",
"items": {
"properties": {
"name": {
"description": "Name of the segment on which segment analysis is being performed.",
"type": "string"
},
"value": {
"description": "Value of the segment attribute to segment on.",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 10,
"type": "array",
"x-versionadded": "v2.36"
},
"timestamp": {
"description": "Value timestamp.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"value": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Custom metric value to ingest."
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"dryRun": {
"default": false,
"description": "Determines if the custom metric data calculated for this run is saved to the database.",
"type": "boolean"
},
"modelId": {
"default": null,
"description": "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.",
"type": [
"string",
"null"
]
},
"modelPackageId": {
"default": null,
"description": "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.",
"type": [
"string",
"null"
]
}
},
"required": [
"buckets",
"dryRun"
],
"type": "object"
}
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
202 Response
{
"description": "A custom metric definition.",
"properties": {
"associationId": {
"description": "A custom metric associationId source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Category values",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Custom metric creation timestamp.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The user that created custom metric.",
"properties": {
"id": {
"description": "The ID of user who created custom metric.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"displayChart": {
"description": "Indicates if UI should show chart by default.",
"type": "boolean"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"metadata": {
"description": "A custom metric metadata source when reading values from columnar datasets like a file.",
"properties": {
"columnName": {
"description": "Column name",
"maxLength": 128,
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"timeStep": {
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"isModelSpecific",
"name",
"timeStep",
"type"
],
"type": "object"
}
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.
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. |
| segmentAttribute |
query |
string |
false |
The name of the segment on which segment analysis is being performed. |
| segmentValue |
query |
string |
false |
The value of the segmentAttribute to segment on. |
| 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
200 Response
{
"properties": {
"metric": {
"description": "Summary of the custom metric.",
"properties": {
"baselineValue": {
"description": "Baseline value.",
"type": [
"number",
"null"
]
},
"categories": {
"description": "Category values.",
"items": {
"properties": {
"baselineValue": {
"description": "A reference value for the current category count.",
"type": [
"number",
"null"
]
},
"categoryName": {
"description": "Category value",
"type": "string"
},
"percentChange": {
"description": "Percent change when compared with the reference value.",
"type": [
"number",
"null"
]
},
"value": {
"description": "A value for the current category count.",
"type": [
"number",
"null"
]
}
},
"required": [
"categoryName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"percentChange": {
"description": "Percentage change of the baseline over its baseline.",
"type": [
"number",
"null"
]
},
"sampleCount": {
"description": "Number of samples used to calculate the aggregated value.",
"type": [
"integer",
"null"
]
},
"unknownCategoriesCount": {
"description": "Count of unknown categories for categorical metrics.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.35"
},
"value": {
"description": "Aggregated value of the custom metric.",
"type": [
"number",
"null"
]
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"period": {
"description": "A time period defined by a start and end time",
"properties": {
"end": {
"description": "End of the bucket.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "Start of the bucket.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
},
"required": [
"metric",
"period"
],
"type": "object"
}
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.
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. |
| segmentAttribute |
query |
string |
false |
The name of the segment on which segment analysis is being performed. |
| segmentValue |
query |
string |
false |
The value of the segmentAttribute to segment on. |
| deploymentId |
path |
string |
true |
ID of the deployment |
| customMetricId |
path |
string |
true |
ID of the custom metric |
Example responses
200 Response
{
"properties": {
"buckets": {
"description": "A list of bucketed batches and the custom metric values aggregated over that batches.",
"items": {
"properties": {
"batch": {
"description": "Describes a batch associated with the bucket.",
"properties": {
"createdAt": {
"description": "Timestamp when the batch was created.",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "DataRobot assigned ID of the batch.",
"type": "string",
"x-versionadded": "v2.33"
},
"lastPredictionTimestamp": {
"description": "Timestamp when the latest prediction request of the batch was made",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.33"
},
"name": {
"description": "User provided name of the batch.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"createdAt",
"id",
"name"
],
"type": "object"
},
"categories": {
"description": "Aggregated custom metric categories in the bucket.",
"items": {
"properties": {
"categoryName": {
"description": "Category value.",
"type": "string"
},
"count": {
"description": "Count of the categories in the bucket.",
"type": "integer"
}
},
"required": [
"categoryName",
"count"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.35"
},
"sampleSize": {
"description": "Total number of values aggregated in the bucket.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.33"
},
"unknownCategoriesCount": {
"description": "The count of the values that do not correspond to the any of the known categories.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.35"
},
"value": {
"description": "Aggregated custom metric value in the bucket.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"batch"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"metric": {
"description": "A custom metric definition.",
"properties": {
"associationId": {
"description": "A custom metric associationId source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Category values",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Custom metric creation timestamp.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The user that created custom metric.",
"properties": {
"id": {
"description": "The ID of user who created custom metric.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"displayChart": {
"description": "Indicates if UI should show chart by default.",
"type": "boolean"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"metadata": {
"description": "A custom metric metadata source when reading values from columnar datasets like a file.",
"properties": {
"columnName": {
"description": "Column name",
"maxLength": 128,
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"timeStep": {
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"isModelSpecific",
"name",
"timeStep",
"type"
],
"type": "object"
},
"segmentAttribute": {
"description": "The name of the segment on which segment analysis is being performed.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"segmentValue": {
"description": "The value of the `segmentAttribute` to segment on.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"buckets",
"metric"
],
"type": "object"
}
Responses
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.
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
200 Response
{
"properties": {
"buckets": {
"description": "A list of buckets containing aggregated custom metric values.",
"items": {
"properties": {
"categories": {
"description": "Aggregated custom metric categories in the bucket.",
"items": {
"properties": {
"categoryName": {
"description": "Category value.",
"type": "string"
},
"count": {
"description": "Count of the categories in the bucket.",
"type": "integer"
}
},
"required": [
"categoryName",
"count"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 25,
"type": "array"
},
"hexagon": {
"description": "h3 hexagon.",
"type": "string"
},
"sampleSize": {
"description": "Total number of values aggregated in the bucket.",
"type": [
"integer",
"null"
]
},
"unknownCategoriesCount": {
"description": "The count of the values that do not correspond to the any of the known categories.",
"type": [
"integer",
"null"
]
},
"value": {
"description": "Aggregated custom metric value in the bucket.",
"type": [
"number",
"null"
]
}
},
"required": [
"hexagon"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 1000,
"type": "array"
},
"metric": {
"description": "A custom metric definition.",
"properties": {
"associationId": {
"description": "A custom metric associationId source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Category values",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Custom metric creation timestamp.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The user that created custom metric.",
"properties": {
"id": {
"description": "The ID of user who created custom metric.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"displayChart": {
"description": "Indicates if UI should show chart by default.",
"type": "boolean"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"metadata": {
"description": "A custom metric metadata source when reading values from columnar datasets like a file.",
"properties": {
"columnName": {
"description": "Column name",
"maxLength": 128,
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"timeStep": {
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"isModelSpecific",
"name",
"timeStep",
"type"
],
"type": "object"
},
"modelId": {
"description": "The ID of the model for which metrics are being retrieved. ",
"type": "string"
},
"modelPackageId": {
"description": "The ID of the model package for which metrics are being retrieved.",
"type": [
"string",
"null"
]
},
"summary": {
"description": "Summary of values over time retrieval.",
"properties": {
"end": {
"description": "End of the retrieval range.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "Start of the retrieval range.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
},
"required": [
"buckets",
"metric",
"summary"
],
"type": "object",
"x-versionadded": "v2.36"
}
Responses
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.
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. |
| segmentAttribute |
query |
string |
false |
The name of the segment on which segment analysis is being performed. |
| segmentValue |
query |
string |
false |
The value of the segmentAttribute to segment on. |
| deploymentId |
path |
string |
true |
ID of the deployment |
| customMetricId |
path |
string |
true |
ID of the custom metric |
Example responses
200 Response
{
"properties": {
"buckets": {
"description": "A list of bucketed time periods and the custom metric values aggregated over that period.",
"items": {
"properties": {
"categories": {
"description": "Aggregated custom metric categories in the bucket.",
"items": {
"properties": {
"categoryName": {
"description": "Category value.",
"type": "string"
},
"count": {
"description": "Count of the categories in the bucket.",
"type": "integer"
}
},
"required": [
"categoryName",
"count"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.35"
},
"period": {
"description": "A time period defined by a start and end time",
"properties": {
"end": {
"description": "End of the bucket.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "Start of the bucket.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"sampleSize": {
"description": "Total number of values aggregated in the bucket.",
"type": [
"integer",
"null"
]
},
"unknownCategoriesCount": {
"description": "The count of the values that do not correspond to the any of the known categories.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.35"
},
"value": {
"description": "Aggregated custom metric value in the bucket.",
"type": [
"number",
"null"
]
}
},
"required": [
"period"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"metric": {
"description": "A custom metric definition.",
"properties": {
"associationId": {
"description": "A custom metric associationId source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Category values",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Custom metric creation timestamp.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The user that created custom metric.",
"properties": {
"id": {
"description": "The ID of user who created custom metric.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"displayChart": {
"description": "Indicates if UI should show chart by default.",
"type": "boolean"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"metadata": {
"description": "A custom metric metadata source when reading values from columnar datasets like a file.",
"properties": {
"columnName": {
"description": "Column name",
"maxLength": 128,
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"timeStep": {
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"isModelSpecific",
"name",
"timeStep",
"type"
],
"type": "object"
},
"segmentAttribute": {
"description": "The name of the segment on which segment analysis is being performed.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"segmentValue": {
"description": "The value of the `segmentAttribute` to segment on.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"summary": {
"description": "Summary of values over time retrieval.",
"properties": {
"end": {
"description": "End of the retrieval range.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "Start of the retrieval range.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
},
"required": [
"buckets",
"metric",
"summary"
],
"type": "object"
}
Responses
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.
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. |
| segmentAttribute |
query |
string |
false |
The name of the segment on which segment analysis is being performed. |
| segmentValue |
query |
string |
false |
The value of the segmentAttribute to segment on. |
| 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
200 Response
{
"properties": {
"metrics": {
"default": [],
"description": "Custom metrics summaries.",
"items": {
"description": "Summary of the custom metric.",
"properties": {
"baselineValue": {
"description": "Baseline value.",
"type": [
"number",
"null"
]
},
"categories": {
"description": "Category values.",
"items": {
"properties": {
"baselineValue": {
"description": "A reference value for the current category count.",
"type": [
"number",
"null"
]
},
"categoryName": {
"description": "Category value",
"type": "string"
},
"percentChange": {
"description": "Percent change when compared with the reference value.",
"type": [
"number",
"null"
]
},
"value": {
"description": "A value for the current category count.",
"type": [
"number",
"null"
]
}
},
"required": [
"categoryName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"percentChange": {
"description": "Percentage change of the baseline over its baseline.",
"type": [
"number",
"null"
]
},
"sampleCount": {
"description": "Number of samples used to calculate the aggregated value.",
"type": [
"integer",
"null"
]
},
"unknownCategoriesCount": {
"description": "Count of unknown categories for categorical metrics.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.35"
},
"value": {
"description": "Aggregated value of the custom metric.",
"type": [
"number",
"null"
]
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"maxItems": 50,
"type": "array",
"x-versionadded": "v2.33"
}
},
"required": [
"metrics"
],
"type": "object"
}
Responses
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.
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. |
| segmentAttribute |
query |
string |
false |
The name of the segment on which segment analysis is being performed. |
| segmentValue |
query |
string |
false |
The value of the segmentAttribute to segment on. |
| 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
200 Response
{
"properties": {
"details": {
"description": "Additional information related to custom metrics.",
"properties": {
"earliestDate": {
"description": "The earliest date of the custom metrics values.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"latestDate": {
"description": "The latest date of the custom metrics values.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"required": [
"earliestDate",
"latestDate"
],
"type": "object"
},
"metrics": {
"default": [],
"description": "Custom metrics summaries.",
"items": {
"description": "Summary of the custom metric.",
"properties": {
"baselineValue": {
"description": "Baseline value.",
"type": [
"number",
"null"
]
},
"categories": {
"description": "Category values.",
"items": {
"properties": {
"baselineValue": {
"description": "A reference value for the current category count.",
"type": [
"number",
"null"
]
},
"categoryName": {
"description": "Category value",
"type": "string"
},
"percentChange": {
"description": "Percent change when compared with the reference value.",
"type": [
"number",
"null"
]
},
"value": {
"description": "A value for the current category count.",
"type": [
"number",
"null"
]
}
},
"required": [
"categoryName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"percentChange": {
"description": "Percentage change of the baseline over its baseline.",
"type": [
"number",
"null"
]
},
"sampleCount": {
"description": "Number of samples used to calculate the aggregated value.",
"type": [
"integer",
"null"
]
},
"unknownCategoriesCount": {
"description": "Count of unknown categories for categorical metrics.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.35"
},
"value": {
"description": "Aggregated value of the custom metric.",
"type": [
"number",
"null"
]
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"maxItems": 50,
"type": "array"
},
"period": {
"description": "A time period defined by a start and end time",
"properties": {
"end": {
"description": "End of the bucket.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "Start of the bucket.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
},
"required": [
"details",
"metrics",
"period"
],
"type": "object"
}
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
AssociationIdField
{
"description": "A custom metric associationId source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
}
A custom metric associationId source when reading values from columnar dataset like a file.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| columnName |
string,null |
true |
|
Column name |
BatchField
{
"description": "A custom metric batch ID source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
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
{
"description": "Describes a batch associated with the bucket.",
"properties": {
"createdAt": {
"description": "Timestamp when the batch was created.",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "DataRobot assigned ID of the batch.",
"type": "string",
"x-versionadded": "v2.33"
},
"lastPredictionTimestamp": {
"description": "Timestamp when the latest prediction request of the batch was made",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.33"
},
"name": {
"description": "User provided name of the batch.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"createdAt",
"id",
"name"
],
"type": "object"
}
Describes a batch associated with the bucket.
Properties
| Name |
Type |
Required |
Restrictions |
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
{
"properties": {
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"batch": {
"description": "A custom metric batch ID source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"categories": {
"description": "Category values. This field is required for categorical custom metrics.",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "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.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "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.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "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\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": "string"
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"type": "object",
"x-versionadded": "v2.34"
}
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. |
| categories |
[CustomMetricCategory] |
false |
maxItems: 25
|
Category values. This field is required for categorical custom metrics. |
| 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
{
"properties": {
"description": {
"default": "",
"description": "Description of the hosted custom metric job.",
"maxLength": 1000,
"type": "string"
},
"name": {
"description": "Name of the hosted custom metric job.",
"maxLength": 255,
"type": "string"
},
"sidecarDeploymentId": {
"description": "Sidecar deployment ID.",
"type": "string"
},
"templateId": {
"description": "Custom Metric Template ID.",
"type": "string"
}
},
"required": [
"name",
"templateId"
],
"type": "object",
"x-versionadded": "v2.34"
}
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
{
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "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.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
}
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
{
"properties": {
"created": {
"description": "ISO-8601 timestamp of when the custom job was created.",
"type": "string",
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the custom job.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"entryPoint": {
"description": "The ID of the entry point file to use.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentId": {
"description": "The ID of the execution environment used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentVersionId": {
"description": "The ID of the execution environment version used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"jobType": {
"description": "Type of the custom job.",
"enum": [
"default",
"hostedCustomMetric",
"notification",
"retraining"
],
"type": "string",
"x-versionadded": "v2.33"
},
"lastRun": {
"description": "The last custom job run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "The name of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "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.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameters": {
"description": "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.",
"items": {
"properties": {
"allowEmpty": {
"default": true,
"description": "Indicates whether the param must be set before registration",
"type": "boolean",
"x-versionadded": "v2.33"
},
"credentialType": {
"description": "The type of credential, required only for credentials parameters.",
"enum": [
"adlsGen2Oauth",
"apiToken",
"azure",
"azureServicePrincipal",
"basic",
"bearer",
"databricksAccessTokenAccount",
"databricksServicePrincipalAccount",
"gcp",
"oauth",
"rsa",
"s3",
"sapOauth",
"snowflakeKeyPairUserAccount",
"snowflakeOauthUserAccount",
"tableauAccessToken"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"currentValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Given the default and the override, this is the actual current value of the parameter.",
"x-versionadded": "v2.33"
},
"defaultValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "The default value for the given field.",
"x-versionadded": "v2.33"
},
"description": {
"description": "Description how this parameter impacts the running model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"fieldName": {
"description": "The parameter name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"maxValue": {
"description": "The maximum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"minValue": {
"description": "The minimum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"overrideValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Value set by the user that overrides the default set in the definition.",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"updated": {
"description": "ISO-8601 timestamp of when custom job was last updated.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"created",
"environmentId",
"environmentVersionId",
"id",
"items",
"jobType",
"lastRun",
"name",
"resources",
"updated"
],
"type": "object"
}
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
{
"properties": {
"metric": {
"description": "Summary of the custom metric.",
"properties": {
"baselineValue": {
"description": "Baseline value.",
"type": [
"number",
"null"
]
},
"categories": {
"description": "Category values.",
"items": {
"properties": {
"baselineValue": {
"description": "A reference value for the current category count.",
"type": [
"number",
"null"
]
},
"categoryName": {
"description": "Category value",
"type": "string"
},
"percentChange": {
"description": "Percent change when compared with the reference value.",
"type": [
"number",
"null"
]
},
"value": {
"description": "A value for the current category count.",
"type": [
"number",
"null"
]
}
},
"required": [
"categoryName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"percentChange": {
"description": "Percentage change of the baseline over its baseline.",
"type": [
"number",
"null"
]
},
"sampleCount": {
"description": "Number of samples used to calculate the aggregated value.",
"type": [
"integer",
"null"
]
},
"unknownCategoriesCount": {
"description": "Count of unknown categories for categorical metrics.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.35"
},
"value": {
"description": "Aggregated value of the custom metric.",
"type": [
"number",
"null"
]
}
},
"required": [
"id",
"name"
],
"type": "object"
}
},
"required": [
"metric"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| metric |
MetricSummary |
true |
|
Summary of the custom metric. |
CustomMetricCategory
{
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| baselineCount |
integer,null |
false |
|
A reference value for the current category count. |
| directionality |
string |
true |
|
Directionality of the custom metric category. |
| value |
string |
true |
|
Category value |
Enumerated Values
| Property |
Value |
| directionality |
[higherIsBetter, lowerIsBetter] |
CustomMetricCategorySummary
{
"properties": {
"baselineValue": {
"description": "A reference value for the current category count.",
"type": [
"number",
"null"
]
},
"categoryName": {
"description": "Category value",
"type": "string"
},
"percentChange": {
"description": "Percent change when compared with the reference value.",
"type": [
"number",
"null"
]
},
"value": {
"description": "A value for the current category count.",
"type": [
"number",
"null"
]
}
},
"required": [
"categoryName"
],
"type": "object",
"x-versionadded": "v2.36"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| baselineValue |
number,null |
false |
|
A reference value for the current category count. |
| categoryName |
string |
true |
|
Category value |
| percentChange |
number,null |
false |
|
Percent change when compared with the reference value. |
| value |
number,null |
false |
|
A value for the current category count. |
CustomMetricDetails
{
"description": "Additional information related to custom metrics.",
"properties": {
"earliestDate": {
"description": "The earliest date of the custom metrics values.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"latestDate": {
"description": "The latest date of the custom metrics values.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"required": [
"earliestDate",
"latestDate"
],
"type": "object"
}
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
{
"properties": {
"categories": {
"description": "Aggregated custom metric categories in the bucket.",
"items": {
"properties": {
"categoryName": {
"description": "Category value.",
"type": "string"
},
"count": {
"description": "Count of the categories in the bucket.",
"type": "integer"
}
},
"required": [
"categoryName",
"count"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 25,
"type": "array"
},
"hexagon": {
"description": "h3 hexagon.",
"type": "string"
},
"sampleSize": {
"description": "Total number of values aggregated in the bucket.",
"type": [
"integer",
"null"
]
},
"unknownCategoriesCount": {
"description": "The count of the values that do not correspond to the any of the known categories.",
"type": [
"integer",
"null"
]
},
"value": {
"description": "Aggregated custom metric value in the bucket.",
"type": [
"number",
"null"
]
}
},
"required": [
"hexagon"
],
"type": "object",
"x-versionadded": "v2.36"
}
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. |
CustomMetricSegment
{
"properties": {
"name": {
"description": "Name of the segment on which segment analysis is being performed.",
"type": "string"
},
"value": {
"description": "Value of the segment attribute to segment on.",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| name |
string |
true |
|
Name of the segment on which segment analysis is being performed. |
| value |
string |
true |
|
Value of the segment attribute to segment on. |
CustomMetricSegmentDataset
{
"properties": {
"column": {
"description": "Name of the column that contains segment values.",
"type": "string"
},
"name": {
"description": "Name of the segment on which segment analysis is being performed.",
"type": "string"
}
},
"required": [
"column",
"name"
],
"type": "object"
}
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
{
"properties": {
"metric": {
"description": "Summary of the custom metric.",
"properties": {
"baselineValue": {
"description": "Baseline value.",
"type": [
"number",
"null"
]
},
"categories": {
"description": "Category values.",
"items": {
"properties": {
"baselineValue": {
"description": "A reference value for the current category count.",
"type": [
"number",
"null"
]
},
"categoryName": {
"description": "Category value",
"type": "string"
},
"percentChange": {
"description": "Percent change when compared with the reference value.",
"type": [
"number",
"null"
]
},
"value": {
"description": "A value for the current category count.",
"type": [
"number",
"null"
]
}
},
"required": [
"categoryName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"percentChange": {
"description": "Percentage change of the baseline over its baseline.",
"type": [
"number",
"null"
]
},
"sampleCount": {
"description": "Number of samples used to calculate the aggregated value.",
"type": [
"integer",
"null"
]
},
"unknownCategoriesCount": {
"description": "Count of unknown categories for categorical metrics.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.35"
},
"value": {
"description": "Aggregated value of the custom metric.",
"type": [
"number",
"null"
]
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"period": {
"description": "A time period defined by a start and end time",
"properties": {
"end": {
"description": "End of the bucket.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "Start of the bucket.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
},
"required": [
"metric",
"period"
],
"type": "object"
}
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
{
"properties": {
"metrics": {
"default": [],
"description": "Custom metrics summaries.",
"items": {
"description": "Summary of the custom metric.",
"properties": {
"baselineValue": {
"description": "Baseline value.",
"type": [
"number",
"null"
]
},
"categories": {
"description": "Category values.",
"items": {
"properties": {
"baselineValue": {
"description": "A reference value for the current category count.",
"type": [
"number",
"null"
]
},
"categoryName": {
"description": "Category value",
"type": "string"
},
"percentChange": {
"description": "Percent change when compared with the reference value.",
"type": [
"number",
"null"
]
},
"value": {
"description": "A value for the current category count.",
"type": [
"number",
"null"
]
}
},
"required": [
"categoryName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"percentChange": {
"description": "Percentage change of the baseline over its baseline.",
"type": [
"number",
"null"
]
},
"sampleCount": {
"description": "Number of samples used to calculate the aggregated value.",
"type": [
"integer",
"null"
]
},
"unknownCategoriesCount": {
"description": "Count of unknown categories for categorical metrics.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.35"
},
"value": {
"description": "Aggregated value of the custom metric.",
"type": [
"number",
"null"
]
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"maxItems": 50,
"type": "array",
"x-versionadded": "v2.33"
}
},
"required": [
"metrics"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| metrics |
[MetricSummary] |
true |
maxItems: 50
|
Custom metrics summaries. |
CustomMetricsBulkSummary
{
"properties": {
"details": {
"description": "Additional information related to custom metrics.",
"properties": {
"earliestDate": {
"description": "The earliest date of the custom metrics values.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"latestDate": {
"description": "The latest date of the custom metrics values.",
"format": "date-time",
"type": [
"string",
"null"
]
}
},
"required": [
"earliestDate",
"latestDate"
],
"type": "object"
},
"metrics": {
"default": [],
"description": "Custom metrics summaries.",
"items": {
"description": "Summary of the custom metric.",
"properties": {
"baselineValue": {
"description": "Baseline value.",
"type": [
"number",
"null"
]
},
"categories": {
"description": "Category values.",
"items": {
"properties": {
"baselineValue": {
"description": "A reference value for the current category count.",
"type": [
"number",
"null"
]
},
"categoryName": {
"description": "Category value",
"type": "string"
},
"percentChange": {
"description": "Percent change when compared with the reference value.",
"type": [
"number",
"null"
]
},
"value": {
"description": "A value for the current category count.",
"type": [
"number",
"null"
]
}
},
"required": [
"categoryName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"percentChange": {
"description": "Percentage change of the baseline over its baseline.",
"type": [
"number",
"null"
]
},
"sampleCount": {
"description": "Number of samples used to calculate the aggregated value.",
"type": [
"integer",
"null"
]
},
"unknownCategoriesCount": {
"description": "Count of unknown categories for categorical metrics.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.35"
},
"value": {
"description": "Aggregated value of the custom metric.",
"type": [
"number",
"null"
]
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"maxItems": 50,
"type": "array"
},
"period": {
"description": "A time period defined by a start and end time",
"properties": {
"end": {
"description": "End of the bucket.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "Start of the bucket.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
},
"required": [
"details",
"metrics",
"period"
],
"type": "object"
}
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
{
"description": "The deployment associated to the custom metric.",
"properties": {
"createdAt": {
"description": "Timestamp when the deployment was created.",
"format": "date-time",
"type": "string"
},
"creatorFirstName": {
"description": "First name of the deployment creator.",
"type": [
"string",
"null"
]
},
"creatorGravatarHash": {
"description": "Gravatar hash of the deployment creator.",
"type": [
"string",
"null"
]
},
"creatorLastName": {
"description": "Last name of the deployment creator.",
"type": [
"string",
"null"
]
},
"creatorUsername": {
"description": "Username of the deployment creator.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the deployment.",
"type": "string"
},
"name": {
"description": "Name of the deployment.",
"type": "string"
}
},
"required": [
"createdAt",
"creatorFirstName",
"creatorGravatarHash",
"creatorLastName",
"creatorUsername",
"id",
"name"
],
"type": "object",
"x-versionadded": "v2.34"
}
The deployment associated to the custom metric.
Properties
| Name |
Type |
Required |
Restrictions |
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
{
"description": "A custom metric geospatial coordinate source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
}
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
{
"properties": {
"categories": {
"description": "Values of the categories. This field is required for categorical custom metrics.",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"directionality": {
"description": "Directionality of the custom metric. This field is required for numeric custom metrics.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"isGeospatial": {
"description": "Determines whether the metric is geospatial.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"timeStep": {
"default": "hour",
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or the Y-axis label of the given custom metric. This field is required for numeric custom metrics.",
"type": [
"string",
"null"
]
}
},
"required": [
"isModelSpecific",
"timeStep",
"type"
],
"type": "object",
"x-versionadded": "v2.34"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| categories |
[CustomMetricCategory] |
false |
maxItems: 25
|
Values of the categories. This field is required for categorical custom metrics. |
| directionality |
string,null |
false |
|
Directionality of the custom metric. This field is required for numeric custom metrics. |
| isGeospatial |
boolean |
false |
|
Determines whether the metric is geospatial. |
| 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
{
"properties": {
"categories": {
"description": "Values of the categories. This field is required for categorical custom metrics.",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Hosted custom metric template creation timestamp.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "ID of the user who created the hosted custom metric template.",
"type": "string"
},
"customJobId": {
"description": "ID of the associatedCustom job.",
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric. This field is required for numeric custom metrics.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"id": {
"description": "ID of the hosted custom metric template.",
"type": "string"
},
"isGeospatial": {
"description": "Determines whether the metric is geospatial.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"timeStep": {
"default": "hour",
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or the Y-axis label of the given custom metric. This field is required for numeric custom metrics.",
"type": [
"string",
"null"
]
},
"updatedAt": {
"description": "Hosted custom metric template update timestamp.",
"format": "date-time",
"type": "string"
},
"updatedBy": {
"description": "ID of the user who updated the hosted custom metric template.",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"customJobId",
"id",
"isModelSpecific",
"timeStep",
"type",
"updatedAt",
"updatedBy"
],
"type": "object",
"x-versionadded": "v2.34"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| categories |
[CustomMetricCategory] |
false |
maxItems: 25
|
Values of the categories. This field is required for categorical custom metrics. |
| 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. |
| isGeospatial |
boolean |
false |
|
Determines whether the metric is geospatial. |
| 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
{
"properties": {
"categories": {
"description": "Values of the categories. This field is required for categorical custom metrics.",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"isGeospatial": {
"description": "Determines whether the metric is geospatial.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"timeStep": {
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": "string"
}
},
"type": "object",
"x-versionadded": "v2.34"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| categories |
[CustomMetricCategory] |
false |
maxItems: 25
|
Values of the categories. This field is required for categorical custom metrics. |
| directionality |
string |
false |
|
Directionality of the custom metric. |
| isGeospatial |
boolean |
false |
|
Determines whether the metric is geospatial. |
| 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] |
{
"description": "A custom metric metadata source when reading values from columnar datasets like a file.",
"properties": {
"columnName": {
"description": "Column name",
"maxLength": 128,
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
}
A custom metric metadata source when reading values from columnar datasets like a file.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| columnName |
string,null |
true |
maxLength: 128
|
Column name |
MetricBaselineValue
{
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| value |
number |
true |
|
A reference value in given metric units. |
MetricCategory
{
"properties": {
"categoryName": {
"description": "Category value.",
"type": "string"
},
"count": {
"description": "Count of the categories in the bucket.",
"type": "integer"
}
},
"required": [
"categoryName",
"count"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| categoryName |
string |
true |
|
Category value. |
| count |
integer |
true |
|
Count of the categories in the bucket. |
MetricCreateFromCustomJob
{
"properties": {
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"customJobId": {
"description": "Custom Job ID.",
"type": "string"
},
"description": {
"default": "",
"description": "Description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"geospatialSegmentAttribute": {
"description": "Name of the column that contains geospatial values.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"name": {
"description": "Name of the custom metric.",
"maxLength": 255,
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "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.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "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.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "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\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"customJobId",
"name"
],
"type": "object",
"x-versionadded": "v2.34"
}
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. |
| geospatialSegmentAttribute |
string,null |
false |
|
Name of the column that contains geospatial values. |
| 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
{
"properties": {
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Values of the categories. This field is required for categorical custom metrics.",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Hosted custom metric creation timestamp.",
"format": "date-time",
"type": "string"
},
"deployment": {
"description": "The deployment associated to the custom metric.",
"properties": {
"createdAt": {
"description": "Timestamp when the deployment was created.",
"format": "date-time",
"type": "string"
},
"creatorFirstName": {
"description": "First name of the deployment creator.",
"type": [
"string",
"null"
]
},
"creatorGravatarHash": {
"description": "Gravatar hash of the deployment creator.",
"type": [
"string",
"null"
]
},
"creatorLastName": {
"description": "Last name of the deployment creator.",
"type": [
"string",
"null"
]
},
"creatorUsername": {
"description": "Username of the deployment creator.",
"type": [
"string",
"null"
]
},
"id": {
"description": "The ID of the deployment.",
"type": "string"
},
"name": {
"description": "Name of the deployment.",
"type": "string"
}
},
"required": [
"createdAt",
"creatorFirstName",
"creatorGravatarHash",
"creatorLastName",
"creatorUsername",
"id",
"name"
],
"type": "object",
"x-versionadded": "v2.34"
},
"description": {
"default": "",
"description": "Description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"geospatialSegmentAttribute": {
"description": "Name of the column that contains geospatial values.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"isGeospatial": {
"description": "Determines whether the metric is geospatial.",
"type": "boolean",
"x-versionadded": "v2.36"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"name": {
"description": "Name of the custom metric.",
"maxLength": 255,
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"schedule": {
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "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.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "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.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "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\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
},
"timeStep": {
"default": "hour",
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or the Y-axis label of the given custom metric.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"createdAt",
"deployment",
"directionality",
"id",
"isModelSpecific",
"name",
"timeStep",
"type",
"units"
],
"type": "object",
"x-versionadded": "v2.34"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| baselineValues |
[MetricBaselineValue] |
false |
maxItems: 5
|
Baseline values |
| categories |
[CustomMetricCategory] |
false |
maxItems: 25
|
Values of the categories. This field is required for categorical custom metrics. |
| 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. |
| geospatialSegmentAttribute |
string,null |
false |
|
Name of the column that contains geospatial values. |
| id |
string |
true |
|
The ID of the custom metric. |
| isGeospatial |
boolean |
false |
|
Determines whether the metric is geospatial. |
| 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
{
"properties": {
"baselineValues": {
"description": "Baseline values. This field is required for numeric custom metrics.",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Values of the categories. This field is required for categorical custom metrics.",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric. This field is required for numeric custom metrics.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"timeStep": {
"default": "hour",
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or the Y-axis label of the given custom metric. This field is required for numeric custom metrics.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"isModelSpecific",
"name",
"timeStep",
"type"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| baselineValues |
[MetricBaselineValue] |
false |
maxItems: 5
|
Baseline values. This field is required for numeric custom metrics. |
| categories |
[CustomMetricCategory] |
false |
maxItems: 25
|
Values of the categories. This field is required for categorical 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
{
"description": "The user that created custom metric.",
"properties": {
"id": {
"description": "The ID of user who created custom metric.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
The user that created custom metric.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| id |
string |
true |
|
The ID of user who created custom metric. |
MetricEntity
{
"description": "A custom metric definition.",
"properties": {
"associationId": {
"description": "A custom metric associationId source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Category values",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Custom metric creation timestamp.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The user that created custom metric.",
"properties": {
"id": {
"description": "The ID of user who created custom metric.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"displayChart": {
"description": "Indicates if UI should show chart by default.",
"type": "boolean"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"metadata": {
"description": "A custom metric metadata source when reading values from columnar datasets like a file.",
"properties": {
"columnName": {
"description": "Column name",
"maxLength": 128,
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"timeStep": {
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"isModelSpecific",
"name",
"timeStep",
"type"
],
"type": "object"
}
A custom metric definition.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| associationId |
AssociationIdField |
false |
|
A custom metric associationId source when reading values from columnar dataset like a file. |
| baselineValues |
[MetricBaselineValue] |
false |
maxItems: 5
|
Baseline values |
| categories |
[CustomMetricCategory] |
false |
maxItems: 25
|
Category 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. |
| metadata |
MetadataField |
false |
|
A custom metric metadata source when reading values from columnar datasets like a file. |
| 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] |
{
"properties": {
"associationId": {
"default": null,
"description": "Identifies prediction row corresponding to value.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"geospatialCoordinate": {
"description": "A geospatial object in WKB or WKT format. Only required for geospatial custom metrics.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.36"
},
"metadata": {
"default": null,
"description": "A read-only metadata association with a custom metric value.",
"maxLength": 128,
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"sampleSize": {
"default": 1,
"description": "Custom metric value sample size.",
"type": "integer"
},
"segments": {
"description": "A list of segments for a custom metric used in segmented analysis. Segments cannot be provided for geospatial metrics.",
"items": {
"properties": {
"name": {
"description": "Name of the segment on which segment analysis is being performed.",
"type": "string"
},
"value": {
"description": "Value of the segment attribute to segment on.",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 10,
"type": "array",
"x-versionadded": "v2.36"
},
"timestamp": {
"description": "Value timestamp.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"value": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Custom metric value to ingest."
}
},
"required": [
"value"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| associationId |
string,null |
false |
|
Identifies prediction row corresponding to value. |
| geospatialCoordinate |
string |
false |
maxLength: 10000
|
A geospatial object in WKB or WKT format. Only required for geospatial custom metrics. |
| metadata |
string,null |
false |
maxLength: 128
|
A read-only metadata association with a custom metric value. |
| sampleSize |
integer |
false |
|
Custom metric value sample size. |
| segments |
[CustomMetricSegment] |
false |
maxItems: 10
|
A list of segments for a custom metric used in segmented analysis. Segments cannot be provided for geospatial metrics. |
| 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 |
or
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
null |
false |
|
none |
MetricListResponse
{
"properties": {
"count": {
"description": "Number of paginated entries.",
"minimum": 0,
"type": "integer"
},
"data": {
"description": "A list of custom metrics.",
"items": {
"description": "A custom metric definition.",
"properties": {
"associationId": {
"description": "A custom metric associationId source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Category values",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Custom metric creation timestamp.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The user that created custom metric.",
"properties": {
"id": {
"description": "The ID of user who created custom metric.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"displayChart": {
"description": "Indicates if UI should show chart by default.",
"type": "boolean"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"metadata": {
"description": "A custom metric metadata source when reading values from columnar datasets like a file.",
"properties": {
"columnName": {
"description": "Column name",
"maxLength": 128,
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"timeStep": {
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"isModelSpecific",
"name",
"timeStep",
"type"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL to the next page, or null if there is no such page",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL to the previous page, or null if there is no such page",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "Total number of entries.",
"minimum": 0,
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
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
{
"description": "A time period defined by a start and end time",
"properties": {
"end": {
"description": "End of the bucket.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "Start of the bucket.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
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
{
"description": "Summary of the custom metric.",
"properties": {
"baselineValue": {
"description": "Baseline value.",
"type": [
"number",
"null"
]
},
"categories": {
"description": "Category values.",
"items": {
"properties": {
"baselineValue": {
"description": "A reference value for the current category count.",
"type": [
"number",
"null"
]
},
"categoryName": {
"description": "Category value",
"type": "string"
},
"percentChange": {
"description": "Percent change when compared with the reference value.",
"type": [
"number",
"null"
]
},
"value": {
"description": "A value for the current category count.",
"type": [
"number",
"null"
]
}
},
"required": [
"categoryName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"percentChange": {
"description": "Percentage change of the baseline over its baseline.",
"type": [
"number",
"null"
]
},
"sampleCount": {
"description": "Number of samples used to calculate the aggregated value.",
"type": [
"integer",
"null"
]
},
"unknownCategoriesCount": {
"description": "Count of unknown categories for categorical metrics.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.35"
},
"value": {
"description": "Aggregated value of the custom metric.",
"type": [
"number",
"null"
]
}
},
"required": [
"id",
"name"
],
"type": "object"
}
Summary of the custom metric.
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| baselineValue |
number,null |
false |
|
Baseline value. |
| categories |
[CustomMetricCategorySummary] |
false |
maxItems: 25
|
Category values. |
| 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
{
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
}
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
{
"properties": {
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"batch": {
"description": "A custom metric batch ID source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"categories": {
"description": "Category values. This field is required for categorical custom metrics.",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": "string"
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"type": "object"
}
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. |
| categories |
[CustomMetricCategory] |
false |
maxItems: 25
|
Category values. This field is required for categorical custom metrics. |
| 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
{
"properties": {
"associationId": {
"description": "A custom metric batch ID source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"batch": {
"description": "A custom metric batch ID source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"datasetId": {
"description": "Dataset ID to process.",
"type": "string"
},
"geospatial": {
"description": "A custom metric geospatial coordinate source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"modelId": {
"default": null,
"description": "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.",
"type": [
"string",
"null"
]
},
"modelPackageId": {
"default": null,
"description": "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.",
"type": [
"string",
"null"
]
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"segments": {
"description": "A list of segments for a custom metric used in segmented analysis. Cannot be used with geospatial custom metrics.",
"items": {
"properties": {
"column": {
"description": "Name of the column that contains segment values.",
"type": "string"
},
"name": {
"description": "Name of the segment on which segment analysis is being performed.",
"type": "string"
}
},
"required": [
"column",
"name"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"datasetId"
],
"type": "object"
}
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
{
"properties": {
"buckets": {
"description": "A list of timestamped buckets with custom metric values.",
"items": {
"properties": {
"associationId": {
"default": null,
"description": "Identifies prediction row corresponding to value.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"geospatialCoordinate": {
"description": "A geospatial object in WKB or WKT format. Only required for geospatial custom metrics.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.36"
},
"metadata": {
"default": null,
"description": "A read-only metadata association with a custom metric value.",
"maxLength": 128,
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"sampleSize": {
"default": 1,
"description": "Custom metric value sample size.",
"type": "integer"
},
"segments": {
"description": "A list of segments for a custom metric used in segmented analysis. Segments cannot be provided for geospatial metrics.",
"items": {
"properties": {
"name": {
"description": "Name of the segment on which segment analysis is being performed.",
"type": "string"
},
"value": {
"description": "Value of the segment attribute to segment on.",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 10,
"type": "array",
"x-versionadded": "v2.36"
},
"timestamp": {
"description": "Value timestamp.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"value": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Custom metric value to ingest."
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 10000,
"type": "array"
},
"dryRun": {
"default": false,
"description": "Determines if the custom metric data calculated for this run is saved to the database.",
"type": "boolean"
},
"modelId": {
"default": null,
"description": "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.",
"type": [
"string",
"null"
]
},
"modelPackageId": {
"default": null,
"description": "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.",
"type": [
"string",
"null"
]
}
},
"required": [
"buckets",
"dryRun"
],
"type": "object"
}
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
{
"properties": {
"batch": {
"description": "Describes a batch associated with the bucket.",
"properties": {
"createdAt": {
"description": "Timestamp when the batch was created.",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "DataRobot assigned ID of the batch.",
"type": "string",
"x-versionadded": "v2.33"
},
"lastPredictionTimestamp": {
"description": "Timestamp when the latest prediction request of the batch was made",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.33"
},
"name": {
"description": "User provided name of the batch.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"createdAt",
"id",
"name"
],
"type": "object"
},
"categories": {
"description": "Aggregated custom metric categories in the bucket.",
"items": {
"properties": {
"categoryName": {
"description": "Category value.",
"type": "string"
},
"count": {
"description": "Count of the categories in the bucket.",
"type": "integer"
}
},
"required": [
"categoryName",
"count"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.35"
},
"sampleSize": {
"description": "Total number of values aggregated in the bucket.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.33"
},
"unknownCategoriesCount": {
"description": "The count of the values that do not correspond to the any of the known categories.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.35"
},
"value": {
"description": "Aggregated custom metric value in the bucket.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"batch"
],
"type": "object"
}
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
{
"properties": {
"buckets": {
"description": "A list of bucketed batches and the custom metric values aggregated over that batches.",
"items": {
"properties": {
"batch": {
"description": "Describes a batch associated with the bucket.",
"properties": {
"createdAt": {
"description": "Timestamp when the batch was created.",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "DataRobot assigned ID of the batch.",
"type": "string",
"x-versionadded": "v2.33"
},
"lastPredictionTimestamp": {
"description": "Timestamp when the latest prediction request of the batch was made",
"format": "date-time",
"type": "string",
"x-versionadded": "v2.33"
},
"name": {
"description": "User provided name of the batch.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"createdAt",
"id",
"name"
],
"type": "object"
},
"categories": {
"description": "Aggregated custom metric categories in the bucket.",
"items": {
"properties": {
"categoryName": {
"description": "Category value.",
"type": "string"
},
"count": {
"description": "Count of the categories in the bucket.",
"type": "integer"
}
},
"required": [
"categoryName",
"count"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.35"
},
"sampleSize": {
"description": "Total number of values aggregated in the bucket.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.33"
},
"unknownCategoriesCount": {
"description": "The count of the values that do not correspond to the any of the known categories.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.35"
},
"value": {
"description": "Aggregated custom metric value in the bucket.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"batch"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"metric": {
"description": "A custom metric definition.",
"properties": {
"associationId": {
"description": "A custom metric associationId source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Category values",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Custom metric creation timestamp.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The user that created custom metric.",
"properties": {
"id": {
"description": "The ID of user who created custom metric.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"displayChart": {
"description": "Indicates if UI should show chart by default.",
"type": "boolean"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"metadata": {
"description": "A custom metric metadata source when reading values from columnar datasets like a file.",
"properties": {
"columnName": {
"description": "Column name",
"maxLength": 128,
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"timeStep": {
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"isModelSpecific",
"name",
"timeStep",
"type"
],
"type": "object"
},
"segmentAttribute": {
"description": "The name of the segment on which segment analysis is being performed.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"segmentValue": {
"description": "The value of the `segmentAttribute` to segment on.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
}
},
"required": [
"buckets",
"metric"
],
"type": "object"
}
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. |
| segmentAttribute |
string,null |
false |
|
The name of the segment on which segment analysis is being performed. |
| segmentValue |
string,null |
false |
|
The value of the segmentAttribute to segment on. |
MetricValuesOverSpaceResponse
{
"properties": {
"buckets": {
"description": "A list of buckets containing aggregated custom metric values.",
"items": {
"properties": {
"categories": {
"description": "Aggregated custom metric categories in the bucket.",
"items": {
"properties": {
"categoryName": {
"description": "Category value.",
"type": "string"
},
"count": {
"description": "Count of the categories in the bucket.",
"type": "integer"
}
},
"required": [
"categoryName",
"count"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 25,
"type": "array"
},
"hexagon": {
"description": "h3 hexagon.",
"type": "string"
},
"sampleSize": {
"description": "Total number of values aggregated in the bucket.",
"type": [
"integer",
"null"
]
},
"unknownCategoriesCount": {
"description": "The count of the values that do not correspond to the any of the known categories.",
"type": [
"integer",
"null"
]
},
"value": {
"description": "Aggregated custom metric value in the bucket.",
"type": [
"number",
"null"
]
}
},
"required": [
"hexagon"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 1000,
"type": "array"
},
"metric": {
"description": "A custom metric definition.",
"properties": {
"associationId": {
"description": "A custom metric associationId source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Category values",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Custom metric creation timestamp.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The user that created custom metric.",
"properties": {
"id": {
"description": "The ID of user who created custom metric.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"displayChart": {
"description": "Indicates if UI should show chart by default.",
"type": "boolean"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"metadata": {
"description": "A custom metric metadata source when reading values from columnar datasets like a file.",
"properties": {
"columnName": {
"description": "Column name",
"maxLength": 128,
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"timeStep": {
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"isModelSpecific",
"name",
"timeStep",
"type"
],
"type": "object"
},
"modelId": {
"description": "The ID of the model for which metrics are being retrieved. ",
"type": "string"
},
"modelPackageId": {
"description": "The ID of the model package for which metrics are being retrieved.",
"type": [
"string",
"null"
]
},
"summary": {
"description": "Summary of values over time retrieval.",
"properties": {
"end": {
"description": "End of the retrieval range.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "Start of the retrieval range.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
},
"required": [
"buckets",
"metric",
"summary"
],
"type": "object",
"x-versionadded": "v2.36"
}
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
{
"properties": {
"categories": {
"description": "Aggregated custom metric categories in the bucket.",
"items": {
"properties": {
"categoryName": {
"description": "Category value.",
"type": "string"
},
"count": {
"description": "Count of the categories in the bucket.",
"type": "integer"
}
},
"required": [
"categoryName",
"count"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.35"
},
"period": {
"description": "A time period defined by a start and end time",
"properties": {
"end": {
"description": "End of the bucket.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "Start of the bucket.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"sampleSize": {
"description": "Total number of values aggregated in the bucket.",
"type": [
"integer",
"null"
]
},
"unknownCategoriesCount": {
"description": "The count of the values that do not correspond to the any of the known categories.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.35"
},
"value": {
"description": "Aggregated custom metric value in the bucket.",
"type": [
"number",
"null"
]
}
},
"required": [
"period"
],
"type": "object"
}
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
{
"properties": {
"buckets": {
"description": "A list of bucketed time periods and the custom metric values aggregated over that period.",
"items": {
"properties": {
"categories": {
"description": "Aggregated custom metric categories in the bucket.",
"items": {
"properties": {
"categoryName": {
"description": "Category value.",
"type": "string"
},
"count": {
"description": "Count of the categories in the bucket.",
"type": "integer"
}
},
"required": [
"categoryName",
"count"
],
"type": "object",
"x-versionadded": "v2.35"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.35"
},
"period": {
"description": "A time period defined by a start and end time",
"properties": {
"end": {
"description": "End of the bucket.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "Start of the bucket.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"sampleSize": {
"description": "Total number of values aggregated in the bucket.",
"type": [
"integer",
"null"
]
},
"unknownCategoriesCount": {
"description": "The count of the values that do not correspond to the any of the known categories.",
"type": [
"integer",
"null"
],
"x-versionadded": "v2.35"
},
"value": {
"description": "Aggregated custom metric value in the bucket.",
"type": [
"number",
"null"
]
}
},
"required": [
"period"
],
"type": "object"
},
"maxItems": 100,
"type": "array"
},
"metric": {
"description": "A custom metric definition.",
"properties": {
"associationId": {
"description": "A custom metric associationId source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"baselineValues": {
"description": "Baseline values",
"items": {
"properties": {
"value": {
"description": "A reference value in given metric units.",
"type": "number"
}
},
"required": [
"value"
],
"type": "object"
},
"maxItems": 5,
"type": "array"
},
"categories": {
"description": "Category values",
"items": {
"properties": {
"baselineCount": {
"description": "A reference value for the current category count.",
"type": [
"integer",
"null"
]
},
"directionality": {
"description": "Directionality of the custom metric category.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": "string"
},
"value": {
"description": "Category value",
"type": "string"
}
},
"required": [
"directionality",
"value"
],
"type": "object",
"x-versionadded": "v2.36"
},
"maxItems": 25,
"type": "array",
"x-versionadded": "v2.36"
},
"createdAt": {
"description": "Custom metric creation timestamp.",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "The user that created custom metric.",
"properties": {
"id": {
"description": "The ID of user who created custom metric.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"description": {
"description": "A description of the custom metric.",
"maxLength": 1000,
"type": "string"
},
"directionality": {
"description": "Directionality of the custom metric.",
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"type": [
"string",
"null"
]
},
"displayChart": {
"description": "Indicates if UI should show chart by default.",
"type": "boolean"
},
"id": {
"description": "The ID of the custom metric.",
"type": "string"
},
"isModelSpecific": {
"description": "Determines whether the metric is related to the model or deployment.",
"type": "boolean"
},
"metadata": {
"description": "A custom metric metadata source when reading values from columnar datasets like a file.",
"properties": {
"columnName": {
"description": "Column name",
"maxLength": 128,
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object",
"x-versionadded": "v2.36"
},
"name": {
"description": "Name of the custom metric.",
"type": "string"
},
"sampleCount": {
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
},
"timeStep": {
"description": "Custom metric time bucket size.",
"enum": [
"hour"
],
"type": "string"
},
"timestamp": {
"description": "A custom metric timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
},
"timeFormat": {
"description": "Format",
"enum": [
"%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"
],
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": {
"description": "Type (and aggregation character) of a metric.",
"enum": [
"average",
"categorical",
"gauge",
"sum"
],
"type": "string"
},
"units": {
"description": "Units or Y Label of given custom metric.",
"type": [
"string",
"null"
]
},
"value": {
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
},
"required": [
"createdAt",
"createdBy",
"id",
"isModelSpecific",
"name",
"timeStep",
"type"
],
"type": "object"
},
"segmentAttribute": {
"description": "The name of the segment on which segment analysis is being performed.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"segmentValue": {
"description": "The value of the `segmentAttribute` to segment on.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.36"
},
"summary": {
"description": "Summary of values over time retrieval.",
"properties": {
"end": {
"description": "End of the retrieval range.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "Start of the retrieval range.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
},
"required": [
"buckets",
"metric",
"summary"
],
"type": "object"
}
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. |
| segmentAttribute |
string,null |
false |
|
The name of the segment on which segment analysis is being performed. |
| segmentValue |
string,null |
false |
|
The value of the segmentAttribute to segment on. |
| summary |
MetricValuesOverTimeSummary |
true |
|
Summary of values over time retrieval. |
MetricValuesOverTimeSummary
{
"description": "Summary of values over time retrieval.",
"properties": {
"end": {
"description": "End of the retrieval range.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "Start of the retrieval range.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
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
{
"properties": {
"allowEmpty": {
"default": true,
"description": "Indicates whether the param must be set before registration",
"type": "boolean",
"x-versionadded": "v2.33"
},
"credentialType": {
"description": "The type of credential, required only for credentials parameters.",
"enum": [
"adlsGen2Oauth",
"apiToken",
"azure",
"azureServicePrincipal",
"basic",
"bearer",
"databricksAccessTokenAccount",
"databricksServicePrincipalAccount",
"gcp",
"oauth",
"rsa",
"s3",
"sapOauth",
"snowflakeKeyPairUserAccount",
"snowflakeOauthUserAccount",
"tableauAccessToken"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"currentValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Given the default and the override, this is the actual current value of the parameter.",
"x-versionadded": "v2.33"
},
"defaultValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "The default value for the given field.",
"x-versionadded": "v2.33"
},
"description": {
"description": "Description how this parameter impacts the running model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"fieldName": {
"description": "The parameter name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"maxValue": {
"description": "The maximum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"minValue": {
"description": "The minimum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"overrideValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Value set by the user that overrides the default set in the definition.",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
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 |
or
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
null |
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 |
or
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
null |
false |
|
none |
continued
| Name |
Type |
Required |
Restrictions |
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 |
or
| Name |
Type |
Required |
Restrictions |
Description |
| » anonymous |
null |
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
{
"description": "Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
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
{
"description": "The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.",
"properties": {
"dayOfMonth": {
"description": "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.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31
],
"type": [
"number",
"string"
]
},
"maxItems": 31,
"type": "array"
},
"dayOfWeek": {
"description": "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.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
"sunday",
"SUNDAY",
"Sunday",
"monday",
"MONDAY",
"Monday",
"tuesday",
"TUESDAY",
"Tuesday",
"wednesday",
"WEDNESDAY",
"Wednesday",
"thursday",
"THURSDAY",
"Thursday",
"friday",
"FRIDAY",
"Friday",
"saturday",
"SATURDAY",
"Saturday",
"sun",
"SUN",
"Sun",
"mon",
"MON",
"Mon",
"tue",
"TUE",
"Tue",
"wed",
"WED",
"Wed",
"thu",
"THU",
"Thu",
"fri",
"FRI",
"Fri",
"sat",
"SAT",
"Sat"
],
"type": [
"number",
"string"
]
},
"maxItems": 7,
"type": "array"
},
"hour": {
"description": "The hour(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every hour of the day or ``[0 ... 23]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": [
"number",
"string"
]
},
"maxItems": 24,
"type": "array"
},
"minute": {
"description": "The minute(s) of the day that the job will run. Allowed values are either ``[\"*\"]`` meaning every minute of the day or``[0 ... 59]``.",
"items": {
"enum": [
"*",
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
],
"type": [
"number",
"string"
]
},
"maxItems": 60,
"type": "array"
},
"month": {
"description": "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\"]}``.",
"items": {
"enum": [
"*",
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
"january",
"JANUARY",
"January",
"february",
"FEBRUARY",
"February",
"march",
"MARCH",
"March",
"april",
"APRIL",
"April",
"may",
"MAY",
"May",
"june",
"JUNE",
"June",
"july",
"JULY",
"July",
"august",
"AUGUST",
"August",
"september",
"SEPTEMBER",
"September",
"october",
"OCTOBER",
"October",
"november",
"NOVEMBER",
"November",
"december",
"DECEMBER",
"December",
"jan",
"JAN",
"Jan",
"feb",
"FEB",
"Feb",
"mar",
"MAR",
"Mar",
"apr",
"APR",
"Apr",
"jun",
"JUN",
"Jun",
"jul",
"JUL",
"Jul",
"aug",
"AUG",
"Aug",
"sep",
"SEP",
"Sep",
"oct",
"OCT",
"Oct",
"nov",
"NOV",
"Nov",
"dec",
"DEC",
"Dec"
],
"type": [
"number",
"string"
]
},
"maxItems": 12,
"type": "array"
}
},
"required": [
"dayOfMonth",
"dayOfWeek",
"hour",
"minute",
"month"
],
"type": "object"
}
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
{
"description": "A custom metric value source when reading values from columnar dataset like a file.",
"properties": {
"columnName": {
"description": "Column name",
"type": [
"string",
"null"
]
}
},
"required": [
"columnName"
],
"type": "object"
}
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
{
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
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. |