# Data exports
URL: https://docs.datarobot.com/en/docs/api/reference/public-api/observability_data_exploration.html

> Use the endpoints described below to manage data exploration. Use the data you collect from data exploration tab (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.

# Data exports

Use the endpoints described below to manage data exploration. Use the data you collect from data exploration tab (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.

## Retrieve a list of asynchronous actuals data exports by deployment ID

Operation path: `GET /api/v2/deployments/{deploymentId}/actualsDataExports/`

Authentication requirements: `BearerAuth`

Retrieve a list of asynchronous actuals data exports.

### 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. |
| status | query | string,null | false | An actuals data export state overwrite value. |
| deploymentId | path | string | true | Unique identifier of the deployment. |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| status | [CANCELLED, CREATED, FAILED, SCHEDULED, SUCCEEDED, null] |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "Number of paginated entries.",
      "minimum": 0,
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "A list of asynchronous actuals data exports.",
      "items": {
        "properties": {
          "createdAt": {
            "description": "Actuals data export creation timestamp.",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "createdBy": {
            "description": "The user that created actuals data export.",
            "properties": {
              "id": {
                "description": "The ID of user who created actuals data export.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "id"
            ],
            "type": "object"
          },
          "data": {
            "description": "An actuals data export collected data entries. Available only when status is SUCCEEDED.",
            "items": {
              "properties": {
                "id": {
                  "description": "The ID of an entry.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                },
                "name": {
                  "description": "A name of an entry.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                }
              },
              "required": [
                "id",
                "name"
              ],
              "type": "object"
            },
            "type": "array",
            "x-versionadded": "v2.33"
          },
          "error": {
            "description": "Error description. Appears when actuals data export job failed (status is FAILED).",
            "properties": {
              "message": {
                "description": "A human readable error message describing failure cause.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "message"
            ],
            "type": "object"
          },
          "id": {
            "description": "The ID of the actuals data export.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "modelId": {
            "description": "The ID of the model (or null if not specified).",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "onlyMatchedPredictions": {
            "default": true,
            "description": "If true, exports actuals with matching predictions only.",
            "type": "boolean",
            "x-versionadded": "v2.33"
          },
          "period": {
            "description": "An actuals data time range definition.",
            "properties": {
              "end": {
                "description": "End of the period of actuals data to collect.",
                "format": "date-time",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "start": {
                "description": "Start of the period of actuals data to collect.",
                "format": "date-time",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "end",
              "start"
            ],
            "type": "object"
          },
          "status": {
            "description": "An actuals data export processing state.",
            "enum": [
              "CANCELLED",
              "CREATED",
              "FAILED",
              "SCHEDULED",
              "SUCCEEDED"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "createdAt",
          "createdBy",
          "id",
          "modelId",
          "period",
          "status"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "URL to the next page, or null if there is no such page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "URL to the previous page, or null if there is no such page",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "Total number of entries.",
      "minimum": 0,
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | Success | ActualsExportListResponse |
| 403 | Forbidden | User does not have permission to access a particular deployment. | None |
| 404 | Not Found | Resource not found. | None |
| 422 | Unprocessable Entity | Unable to process the actuals data exports list retrieval due to invalid parameter values. | None |

## Create a deployment actuals data export by deployment ID

Operation path: `POST /api/v2/deployments/{deploymentId}/actualsDataExports/`

Authentication requirements: `BearerAuth`

Create a deployment actuals data export.

### Body parameter

```
{
  "properties": {
    "end": {
      "description": "End of the period of actuals data to collect.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "modelId": {
      "description": "The ID of the model.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "onlyMatchedPredictions": {
      "default": true,
      "description": "If true, exports actuals with matching predictions only.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "start": {
      "description": "Start of the period of actuals data to collect.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "end",
    "start"
  ],
  "type": "object"
}
```

### Parameters

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

### Example responses

> 202 Response

```
{
  "properties": {
    "createdAt": {
      "description": "Actuals data export creation timestamp.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "The user that created actuals data export.",
      "properties": {
        "id": {
          "description": "The ID of user who created actuals data export.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "id"
      ],
      "type": "object"
    },
    "data": {
      "description": "An actuals data export collected data entries. Available only when status is SUCCEEDED.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of an entry.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "A name of an entry.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "error": {
      "description": "Error description. Appears when actuals data export job failed (status is FAILED).",
      "properties": {
        "message": {
          "description": "A human readable error message describing failure cause.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "message"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the actuals data export.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "modelId": {
      "description": "The ID of the model (or null if not specified).",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "onlyMatchedPredictions": {
      "default": true,
      "description": "If true, exports actuals with matching predictions only.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "period": {
      "description": "An actuals data time range definition.",
      "properties": {
        "end": {
          "description": "End of the period of actuals data to collect.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "start": {
          "description": "Start of the period of actuals data to collect.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "end",
        "start"
      ],
      "type": "object"
    },
    "status": {
      "description": "An actuals data export processing state.",
      "enum": [
        "CANCELLED",
        "CREATED",
        "FAILED",
        "SCHEDULED",
        "SUCCEEDED"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "createdAt",
    "createdBy",
    "id",
    "modelId",
    "period",
    "status"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 202 | Accepted | Actuals data export successfully created. | ActualsDataExportEntity |
| 403 | Forbidden | User does not have permission to create an actuals data export. | None |
| 404 | Not Found | Resource not found. | None |
| 422 | Unprocessable Entity | Unable to process the actuals data export creation request. | None |

## Delete an actual export by deployment ID

Operation path: `DELETE /api/v2/deployments/{deploymentId}/actualsDataExports/{exportId}/`

Authentication requirements: `BearerAuth`

Delete an actual export.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| deploymentId | path | string | true | ID of the deployment. |
| exportId | path | string | true | ID of the actuals data export job. |

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | An actual export was successfully deleted. | None |
| 403 | Forbidden | User does not have permission to delete an actual export. | None |
| 404 | Not Found | Actual export was not found. | None |

## Retrieve a single actuals data export by deployment ID

Operation path: `GET /api/v2/deployments/{deploymentId}/actualsDataExports/{exportId}/`

Authentication requirements: `BearerAuth`

Retrieve a single actuals data export.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| deploymentId | path | string | true | ID of the deployment. |
| exportId | path | string | true | ID of the actuals data export job. |

### Example responses

> 200 Response

```
{
  "properties": {
    "createdAt": {
      "description": "Actuals data export creation timestamp.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "The user that created actuals data export.",
      "properties": {
        "id": {
          "description": "The ID of user who created actuals data export.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "id"
      ],
      "type": "object"
    },
    "data": {
      "description": "An actuals data export collected data entries. Available only when status is SUCCEEDED.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of an entry.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "A name of an entry.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "error": {
      "description": "Error description. Appears when actuals data export job failed (status is FAILED).",
      "properties": {
        "message": {
          "description": "A human readable error message describing failure cause.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "message"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the actuals data export.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "modelId": {
      "description": "The ID of the model (or null if not specified).",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "onlyMatchedPredictions": {
      "default": true,
      "description": "If true, exports actuals with matching predictions only.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "period": {
      "description": "An actuals data time range definition.",
      "properties": {
        "end": {
          "description": "End of the period of actuals data to collect.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "start": {
          "description": "Start of the period of actuals data to collect.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "end",
        "start"
      ],
      "type": "object"
    },
    "status": {
      "description": "An actuals data export processing state.",
      "enum": [
        "CANCELLED",
        "CREATED",
        "FAILED",
        "SCHEDULED",
        "SUCCEEDED"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "createdAt",
    "createdBy",
    "id",
    "modelId",
    "period",
    "status"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | A given actuals data export user can view is retrieved. | ActualsDataExportEntity |
| 403 | Forbidden | User does not have permission to access a particular deployment or actuals data export. | None |
| 404 | Not Found | Resource not found. | None |

## Update actuals data export by deployment ID

Operation path: `PATCH /api/v2/deployments/{deploymentId}/actualsDataExports/{exportId}/`

Authentication requirements: `BearerAuth`

Update actuals data export.

### Body parameter

```
{
  "properties": {
    "status": {
      "description": "An actuals data export state overwrite value.",
      "enum": [
        "CANCELLED"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| deploymentId | path | string | true | ID of the deployment. |
| exportId | path | string | true | ID of the actuals data export job. |
| body | body | ActualsDataUpdate | false | none |

### Example responses

> 204 Response

```
{
  "properties": {
    "createdAt": {
      "description": "Actuals data export creation timestamp.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "The user that created actuals data export.",
      "properties": {
        "id": {
          "description": "The ID of user who created actuals data export.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "id"
      ],
      "type": "object"
    },
    "data": {
      "description": "An actuals data export collected data entries. Available only when status is SUCCEEDED.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of an entry.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "A name of an entry.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "error": {
      "description": "Error description. Appears when actuals data export job failed (status is FAILED).",
      "properties": {
        "message": {
          "description": "A human readable error message describing failure cause.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "message"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the actuals data export.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "modelId": {
      "description": "The ID of the model (or null if not specified).",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "onlyMatchedPredictions": {
      "default": true,
      "description": "If true, exports actuals with matching predictions only.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "period": {
      "description": "An actuals data time range definition.",
      "properties": {
        "end": {
          "description": "End of the period of actuals data to collect.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "start": {
          "description": "Start of the period of actuals data to collect.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "end",
        "start"
      ],
      "type": "object"
    },
    "status": {
      "description": "An actuals data export processing state.",
      "enum": [
        "CANCELLED",
        "CREATED",
        "FAILED",
        "SCHEDULED",
        "SUCCEEDED"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "createdAt",
    "createdBy",
    "id",
    "modelId",
    "period",
    "status"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | Actuals data export updated. | ActualsDataExportEntity |
| 403 | Forbidden | User does not have permission to update the actuals data export. | None |
| 404 | Not Found | Requested resource does not exist or the user does not have permission to view it. | None |
| 422 | Unprocessable Entity | Unable to process the actuals data export update. | None |

## Retrieve metadata of the data by deployment ID

Operation path: `GET /api/v2/deployments/{deploymentId}/dataQualityView/`

Authentication requirements: `BearerAuth`

Retrieve metadata of the data to be exported.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| offset | query | integer | false | Specifies the number of rows to skip before starting to return rows from the query. |
| limit | query | integer | false | Specifies the number of rows to return after the offset. |
| start | query | string(date-time) | false | Start of the period of prediction data to collect. Defaults to a week before the end time. |
| end | query | string(date-time) | false | End of the period of prediction data to collect. Defaults to now, or a week after the start time. |
| modelId | query | string | false | The ID of the model. |
| predictionPattern | query | string,null | false | The keywords to search in a predicted value, for text generation target types. |
| promptPattern | query | string,null | false | The keywords to search in a prompt value, for text generation target types. |
| actualPattern | query | string,null | false | The keywords to search in an actual value, for text generation target types. |
| orderBy | query | string,null | false | Field by which to order the text generation target types. |
| orderMetric | query | string,null | false | Metric name or ID used for metric ordering. |
| filterMetric | query | string,null | false | Metric name or ID used for metric filtering. |
| filterValue | query | string,null | false | Metric value required to match value with filter metric name. |
| deploymentId | path | string | true | Unique identifier of the deployment. |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| orderBy | [timestamp, associationId, customMetrics, -timestamp, -associationId, -customMetrics] |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "Number of paginated entries.",
      "minimum": 0,
      "type": "integer"
    },
    "data": {
      "description": "A list of prediction data exports.",
      "items": {
        "properties": {
          "actualValue": {
            "description": "Actual value",
            "type": [
              "string",
              "null"
            ]
          },
          "associationId": {
            "description": "Association ID of prediction.",
            "type": "string"
          },
          "context": {
            "description": "A list of contexts used for text generation response.",
            "items": {
              "properties": {
                "context": {
                  "description": "Text generation context.",
                  "type": "string"
                },
                "link": {
                  "description": "Text generation context link.",
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "required": [
                "context"
              ],
              "type": "object",
              "x-versionadded": "v2.35"
            },
            "maxItems": 10,
            "type": "array"
          },
          "metrics": {
            "description": "A list of collected metrics associated with the prediction instance.",
            "items": {
              "properties": {
                "id": {
                  "description": "The ID of the custom metric.",
                  "type": "string"
                },
                "metadata": {
                  "default": null,
                  "description": "Custom metric value metadata.",
                  "type": [
                    "string",
                    "null"
                  ],
                  "x-versionadded": "v2.35"
                },
                "name": {
                  "description": "Custom metric name.",
                  "type": "string"
                },
                "value": {
                  "description": "Custom metric value.",
                  "oneOf": [
                    {
                      "type": "number"
                    },
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "id",
                "name",
                "value"
              ],
              "type": "object",
              "x-versionadded": "v2.35"
            },
            "maxItems": 100,
            "type": "array"
          },
          "predictedValue": {
            "description": "Predicted value(s)",
            "oneOf": [
              {
                "type": "string"
              },
              {
                "items": {
                  "type": "string"
                },
                "maxItems": 100,
                "type": "array"
              },
              {
                "type": "null"
              }
            ]
          },
          "prompt": {
            "description": "Prompt for text generation target types.",
            "type": [
              "string",
              "null"
            ]
          },
          "timestamp": {
            "description": "Record creation timestamp.",
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "actualValue",
          "associationId",
          "context",
          "metrics",
          "predictedValue",
          "prompt",
          "timestamp"
        ],
        "type": "object",
        "x-versionadded": "v2.35"
      },
      "maxItems": 100,
      "type": "array"
    },
    "next": {
      "description": "The URL to the next page, or null if there is no such page.",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL to the previous page, or null if there is no such page.",
      "type": [
        "string",
        "null"
      ]
    },
    "totalCount": {
      "description": "The total number of entries.",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object",
  "x-versionadded": "v2.35"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | none | DataQualityResponse |

## A list prediction data exports by deployment ID

Operation path: `GET /api/v2/deployments/{deploymentId}/predictionDataExports/`

Authentication requirements: `BearerAuth`

A list of asynchronous prediction data exports.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| offset | query | integer | false | Specifies the number of rows to skip before starting to return rows from the query. |
| limit | query | integer | false | Specifies the number of rows to return after the offset. |
| status | query | string,null | false | A prediction data export processing state. |
| modelId | query | string,null | false | Id of model used for prediction data export. |
| batch | query | string | false | If true, returns just the exports associated with batches. If false, just the real-time ones. If not provided, returns both real-time and batch exports. |
| deploymentId | path | string | true | Unique identifier of the deployment. |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| status | [CANCELLED, CREATED, FAILED, SCHEDULED, SUCCEEDED, null] |
| batch | [false, False, true, True] |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "Number of paginated entries.",
      "minimum": 0,
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "A list of prediction data exports.",
      "items": {
        "properties": {
          "associationIds": {
            "description": "Association IDs of rows to export",
            "items": {
              "type": "string"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array",
            "x-versionadded": "v2.35"
          },
          "augmentationType": {
            "default": "NO_AUGMENTATION",
            "description": "Indicates if prediction data is augmented with actuals or metrics",
            "enum": [
              "NO_AUGMENTATION",
              "ACTUALS_AND_METRICS"
            ],
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "batches": {
            "description": "Metadata associated with exported batch.",
            "items": {
              "properties": {
                "batchId": {
                  "description": "An ID of a batch.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                },
                "batchName": {
                  "description": "A name of a batch.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                }
              },
              "required": [
                "batchId",
                "batchName"
              ],
              "type": "object"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array",
            "x-versionadded": "v2.33"
          },
          "createdAt": {
            "description": "Prediction data export creation timestamp.",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "createdBy": {
            "description": "The user that created prediction data export.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "data": {
            "description": "A prediction data export collected data entries. Available only when status is SUCCEEDED.",
            "items": {
              "properties": {
                "id": {
                  "description": "The ID of the AI Catalog entry.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                },
                "name": {
                  "description": "The name of the AI Catalog entry.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                }
              },
              "required": [
                "id",
                "name"
              ],
              "type": "object"
            },
            "type": "array",
            "x-versionadded": "v2.33"
          },
          "error": {
            "description": "Error description. Appears when prediction data export job failed (status is FAILED).",
            "properties": {
              "message": {
                "description": "A human readable error message describing failure cause.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "message"
            ],
            "type": "object"
          },
          "id": {
            "description": "The ID of the prediction data export.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "modelId": {
            "description": "The ID of the model (or null if not specified).",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "period": {
            "description": "A prediction data time range definition.",
            "properties": {
              "end": {
                "description": "End of the period of prediction data to collect.",
                "format": "date-time",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "start": {
                "description": "Start of the period of prediction data to collect.",
                "format": "date-time",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "end",
              "start"
            ],
            "type": "object"
          },
          "status": {
            "description": "A prediction data export processing state.",
            "enum": [
              "CANCELLED",
              "CREATED",
              "FAILED",
              "SCHEDULED",
              "SUCCEEDED"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "createdAt",
          "createdBy",
          "id",
          "modelId",
          "period",
          "status"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "URL to the next page, or null if there is no such page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "URL to the previous page, or null if there is no such page",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "Total number of entries.",
      "minimum": 0,
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | The prediction data exports. | PredictionExportListResponse |
| 403 | Forbidden | User does not have permission to access a particular deployment. | None |
| 404 | Not Found | Resource not found. | None |
| 422 | Unprocessable Entity | Unable to process the prediction data exports list retrieval due to invalid parameter values. | None |

## Create a deployment prediction data export by deployment ID

Operation path: `POST /api/v2/deployments/{deploymentId}/predictionDataExports/`

Authentication requirements: `BearerAuth`

Create a deployment prediction data export.

### Body parameter

```
{
  "properties": {
    "augmentationType": {
      "default": "NO_AUGMENTATION",
      "description": "Indicates if prediction data is augmented with actuals or metrics",
      "enum": [
        "NO_AUGMENTATION",
        "ACTUALS_AND_METRICS"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "batchIds": {
      "description": "IDs of batches to export. Null for real-time data exports.",
      "items": {
        "type": "string"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "end": {
      "description": "End of the period of prediction data to collect. Defaults to now, or a week after the start time.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "modelId": {
      "description": "The ID of the model.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "start": {
      "description": "Start of the period of prediction data to collect. Defaults to a week before the end time.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

### Parameters

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

### Example responses

> 202 Response

```
{
  "properties": {
    "associationIds": {
      "description": "Association IDs of rows to export",
      "items": {
        "type": "string"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.35"
    },
    "augmentationType": {
      "default": "NO_AUGMENTATION",
      "description": "Indicates if prediction data is augmented with actuals or metrics",
      "enum": [
        "NO_AUGMENTATION",
        "ACTUALS_AND_METRICS"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "batches": {
      "description": "Metadata associated with exported batch.",
      "items": {
        "properties": {
          "batchId": {
            "description": "An ID of a batch.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "batchName": {
            "description": "A name of a batch.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "batchId",
          "batchName"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "createdAt": {
      "description": "Prediction data export creation timestamp.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "The user that created prediction data export.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "A prediction data export collected data entries. Available only when status is SUCCEEDED.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the AI Catalog entry.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the AI Catalog entry.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "error": {
      "description": "Error description. Appears when prediction data export job failed (status is FAILED).",
      "properties": {
        "message": {
          "description": "A human readable error message describing failure cause.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "message"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the prediction data export.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "modelId": {
      "description": "The ID of the model (or null if not specified).",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "period": {
      "description": "A prediction data time range definition.",
      "properties": {
        "end": {
          "description": "End of the period of prediction data to collect.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "start": {
          "description": "Start of the period of prediction data to collect.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "end",
        "start"
      ],
      "type": "object"
    },
    "status": {
      "description": "A prediction data export processing state.",
      "enum": [
        "CANCELLED",
        "CREATED",
        "FAILED",
        "SCHEDULED",
        "SUCCEEDED"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "createdAt",
    "createdBy",
    "id",
    "modelId",
    "period",
    "status"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 202 | Accepted | Prediction data export successfully created. | ExportEntity |
| 403 | Forbidden | User does not have permission to create a prediction data export. | None |
| 404 | Not Found | Resource not found. | None |
| 422 | Unprocessable Entity | Unable to process the prediction data export creation request. | None |

## Retrieve a single prediction data export by deployment ID

Operation path: `GET /api/v2/deployments/{deploymentId}/predictionDataExports/{exportId}/`

Authentication requirements: `BearerAuth`

Retrieve a single prediction data export.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| deploymentId | path | string | true | Unique identifier of the deployment. |
| exportId | path | string | true | Unique identifier of the export. |

### Example responses

> 200 Response

```
{
  "properties": {
    "associationIds": {
      "description": "Association IDs of rows to export",
      "items": {
        "type": "string"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.35"
    },
    "augmentationType": {
      "default": "NO_AUGMENTATION",
      "description": "Indicates if prediction data is augmented with actuals or metrics",
      "enum": [
        "NO_AUGMENTATION",
        "ACTUALS_AND_METRICS"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "batches": {
      "description": "Metadata associated with exported batch.",
      "items": {
        "properties": {
          "batchId": {
            "description": "An ID of a batch.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "batchName": {
            "description": "A name of a batch.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "batchId",
          "batchName"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "createdAt": {
      "description": "Prediction data export creation timestamp.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "The user that created prediction data export.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "A prediction data export collected data entries. Available only when status is SUCCEEDED.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the AI Catalog entry.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the AI Catalog entry.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "error": {
      "description": "Error description. Appears when prediction data export job failed (status is FAILED).",
      "properties": {
        "message": {
          "description": "A human readable error message describing failure cause.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "message"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the prediction data export.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "modelId": {
      "description": "The ID of the model (or null if not specified).",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "period": {
      "description": "A prediction data time range definition.",
      "properties": {
        "end": {
          "description": "End of the period of prediction data to collect.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "start": {
          "description": "Start of the period of prediction data to collect.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "end",
        "start"
      ],
      "type": "object"
    },
    "status": {
      "description": "A prediction data export processing state.",
      "enum": [
        "CANCELLED",
        "CREATED",
        "FAILED",
        "SCHEDULED",
        "SUCCEEDED"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "createdAt",
    "createdBy",
    "id",
    "modelId",
    "period",
    "status"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | A given prediction data export user can view is retrieved. | ExportEntity |
| 403 | Forbidden | User does not have permission to access a particular deployment or prediction data export. | None |
| 404 | Not Found | Resource not found. | None |

## Update prediction data export by deployment ID

Operation path: `PATCH /api/v2/deployments/{deploymentId}/predictionDataExports/{exportId}/`

Authentication requirements: `BearerAuth`

Update prediction data export.

### Body parameter

```
{
  "properties": {
    "status": {
      "description": "A prediction data export processing state.",
      "enum": [
        "CANCELLED"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| deploymentId | path | string | true | Unique identifier of the deployment. |
| exportId | path | string | true | Unique identifier of the export. |
| body | body | PredictionDataUpdate | false | none |

### Example responses

> 204 Response

```
{
  "properties": {
    "associationIds": {
      "description": "Association IDs of rows to export",
      "items": {
        "type": "string"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.35"
    },
    "augmentationType": {
      "default": "NO_AUGMENTATION",
      "description": "Indicates if prediction data is augmented with actuals or metrics",
      "enum": [
        "NO_AUGMENTATION",
        "ACTUALS_AND_METRICS"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "batches": {
      "description": "Metadata associated with exported batch.",
      "items": {
        "properties": {
          "batchId": {
            "description": "An ID of a batch.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "batchName": {
            "description": "A name of a batch.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "batchId",
          "batchName"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "createdAt": {
      "description": "Prediction data export creation timestamp.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "The user that created prediction data export.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "A prediction data export collected data entries. Available only when status is SUCCEEDED.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the AI Catalog entry.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the AI Catalog entry.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "error": {
      "description": "Error description. Appears when prediction data export job failed (status is FAILED).",
      "properties": {
        "message": {
          "description": "A human readable error message describing failure cause.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "message"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the prediction data export.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "modelId": {
      "description": "The ID of the model (or null if not specified).",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "period": {
      "description": "A prediction data time range definition.",
      "properties": {
        "end": {
          "description": "End of the period of prediction data to collect.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "start": {
          "description": "Start of the period of prediction data to collect.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "end",
        "start"
      ],
      "type": "object"
    },
    "status": {
      "description": "A prediction data export processing state.",
      "enum": [
        "CANCELLED",
        "CREATED",
        "FAILED",
        "SCHEDULED",
        "SUCCEEDED"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "createdAt",
    "createdBy",
    "id",
    "modelId",
    "period",
    "status"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 204 | No Content | Prediction data export successfully updated. | ExportEntity |
| 403 | Forbidden | User does not have permission to update a prediction data export. | None |
| 404 | Not Found | Requested resource does not exist or the user does not have permission to view it. | None |
| 422 | Unprocessable Entity | Unable to process the prediction data export update. | None |

## Retrieve predictions results by deployment ID

Operation path: `GET /api/v2/deployments/{deploymentId}/predictionResults/`

Authentication requirements: `BearerAuth`

Retrieve predictions results of the deployment.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| offset | query | integer | false | The number of results to skip. |
| limit | query | integer | false | At most this many results are returned. The default may change without notice. |
| modelId | query | string | false | The id of the model for which prediction results are being retrieved. |
| start | query | string(date-time) | false | Start of the period for which prediction results are being retrieved. |
| end | query | string(date-time) | false | End of the period for which prediction results are being retrieved. |
| batchId | query | any | false | The id of the batch for which prediction results are being retrieved. |
| actualsPresent | query | boolean | false | Filters predictions results to only those who have actuals present or with missing actuals. |
| deploymentId | path | string | true | Unique identifier of the deployment. |
| Accept | header | string | false | Requested MIME type for the returned data |

### Enumerated Values

| Parameter | Value |
| --- | --- |
| Accept | [application/json, text/csv] |

### Example responses

> 200 Response

```
{
  "properties": {
    "associationIdColumnNames": {
      "description": "List of column names used to represent an association id, which is used to unique identify individual prediction rows.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "count": {
      "description": "The number of items returned on this page.",
      "type": "integer"
    },
    "data": {
      "description": "An array of prediction requests.",
      "items": {
        "properties": {
          "actual": {
            "description": "Actual value of the prediction",
            "oneOf": [
              {
                "type": "integer"
              },
              {
                "type": "number"
              },
              {
                "type": "string"
              }
            ]
          },
          "associationId": {
            "description": "Association id of the prediction, which is used to associate a prediction with its actual value and calculate accuracy.",
            "type": "string"
          },
          "forecastDistance": {
            "description": "The number of time units this prediction is away from the forecastPoint. The unit of time is determined by the timeUnit of the datetime partition column. For time series models only.",
            "type": [
              "integer",
              "null"
            ],
            "x-versionadded": "v2.23"
          },
          "modelId": {
            "description": "ID of the model used to make these predictions",
            "type": "string"
          },
          "predicted": {
            "description": "Predicted value of the prediction",
            "oneOf": [
              {
                "type": "integer"
              },
              {
                "type": "number"
              },
              {
                "type": "string"
              }
            ]
          },
          "timestamp": {
            "description": "When the prediction was made.",
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "actual",
          "associationId",
          "modelId",
          "predicted",
          "timestamp"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "next": {
      "description": "The URL of the next page (if null, there is no next page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL of the previous page (if null, there is no previous page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "associationIdColumnNames",
    "data",
    "next",
    "previous"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | none | string |

## The list of training data exports by deployment ID

Operation path: `GET /api/v2/deployments/{deploymentId}/trainingDataExports/`

Authentication requirements: `BearerAuth`

A list of successful training data exports.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| offset | query | integer | false | Specifies the number of rows to skip before starting to return rows from the query. |
| limit | query | integer | false | Specifies the number of rows to return after the offset. |
| modelId | query | string,null | false | ID of model used for training data export. |
| deploymentId | path | string | true | Unique identifier of the deployment. |

### Example responses

> 200 Response

```
{
  "properties": {
    "count": {
      "description": "Number of paginated entries.",
      "minimum": 0,
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "The list of training data exports.",
      "items": {
        "properties": {
          "createdAt": {
            "description": "Training data export creation timestamp.",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "createdBy": {
            "description": "The user who created the training data export.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "data": {
            "description": "A training data entry.",
            "properties": {
              "id": {
                "description": "The ID of the AI Catalog entry.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "name": {
                "description": "The name of the AI Catalog entry.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "id",
              "name"
            ],
            "type": "object"
          },
          "id": {
            "description": "The ID of the training data export.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "modelId": {
            "description": "The ID of the model.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "modelPackageId": {
            "description": "The ID of the related model package.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "createdAt",
          "createdBy",
          "data",
          "id",
          "modelId",
          "modelPackageId"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "URL to the next page, or null if there is no such page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "URL to the previous page, or null if there is no such page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "Total number of entries.",
      "minimum": 0,
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | The training data exports. | TrainingDataExportListResponse |
| 403 | Forbidden | User does not have permission to access a particular deployment. | None |
| 404 | Not Found | Resource not found. | None |
| 422 | Unprocessable Entity | Unable to process the training data exports list retrieval due to invalid parameter values. | None |

## Create a deployment training data export by deployment ID

Operation path: `POST /api/v2/deployments/{deploymentId}/trainingDataExports/`

Authentication requirements: `BearerAuth`

Create a deployment training data export.

### Body parameter

```
{
  "properties": {
    "modelId": {
      "default": null,
      "description": "(Optional) The ID of the model.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

### Parameters

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

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 202 | Accepted | Training data export successfully enqueued. | None |
| 403 | Forbidden | User does not have permission to create a training data export. | None |
| 404 | Not Found | Resource not found. | None |
| 422 | Unprocessable Entity | Unable to process the training data export request. | None |

### Response Headers

| Status | Header | Type | Format | Description |
| --- | --- | --- | --- | --- |
| 202 | Location | string |  | URL to poll to get status of job that waits for the training data export to finish |

## Retrieve details by deployment ID

Operation path: `GET /api/v2/deployments/{deploymentId}/trainingDataExports/{exportId}/`

Authentication requirements: `BearerAuth`

Retrieve details for a single training data export.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| deploymentId | path | string | true | Unique identifier of the deployment. |
| exportId | path | string | true | Unique identifier of the export. |

### Example responses

> 200 Response

```
{
  "properties": {
    "createdAt": {
      "description": "Training data export creation timestamp.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "The user who created the training data export.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "A training data entry.",
      "properties": {
        "id": {
          "description": "The ID of the AI Catalog entry.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "name": {
          "description": "The name of the AI Catalog entry.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the training data export.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "modelId": {
      "description": "The ID of the model.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "modelPackageId": {
      "description": "The ID of the related model package.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "createdAt",
    "createdBy",
    "data",
    "id",
    "modelId",
    "modelPackageId"
  ],
  "type": "object"
}
```

### Responses

| Status | Meaning | Description | Schema |
| --- | --- | --- | --- |
| 200 | OK | A given training data export user can view is retrieved. | TrainingDataExportEntity |
| 403 | Forbidden | User does not have permission to access a particular deployment or training data export. | None |
| 404 | Not Found | Resource not found. | None |

# Schemas

## ActualsCreatedBy

```
{
  "description": "The user that created actuals data export.",
  "properties": {
    "id": {
      "description": "The ID of user who created actuals data export.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}
```

The user that created actuals data export.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| id | string | true |  | The ID of user who created actuals data export. |

## ActualsDataEntry

```
{
  "properties": {
    "id": {
      "description": "The ID of an entry.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "A name of an entry.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| id | string | true |  | The ID of an entry. |
| name | string | true |  | A name of an entry. |

## ActualsDataExportEntity

```
{
  "properties": {
    "createdAt": {
      "description": "Actuals data export creation timestamp.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "The user that created actuals data export.",
      "properties": {
        "id": {
          "description": "The ID of user who created actuals data export.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "id"
      ],
      "type": "object"
    },
    "data": {
      "description": "An actuals data export collected data entries. Available only when status is SUCCEEDED.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of an entry.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "A name of an entry.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "error": {
      "description": "Error description. Appears when actuals data export job failed (status is FAILED).",
      "properties": {
        "message": {
          "description": "A human readable error message describing failure cause.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "message"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the actuals data export.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "modelId": {
      "description": "The ID of the model (or null if not specified).",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "onlyMatchedPredictions": {
      "default": true,
      "description": "If true, exports actuals with matching predictions only.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "period": {
      "description": "An actuals data time range definition.",
      "properties": {
        "end": {
          "description": "End of the period of actuals data to collect.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "start": {
          "description": "Start of the period of actuals data to collect.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "end",
        "start"
      ],
      "type": "object"
    },
    "status": {
      "description": "An actuals data export processing state.",
      "enum": [
        "CANCELLED",
        "CREATED",
        "FAILED",
        "SCHEDULED",
        "SUCCEEDED"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "createdAt",
    "createdBy",
    "id",
    "modelId",
    "period",
    "status"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| createdAt | string(date-time) | true |  | Actuals data export creation timestamp. |
| createdBy | ActualsCreatedBy | true |  | The user that created actuals data export. |
| data | [ActualsDataEntry] | false |  | An actuals data export collected data entries. Available only when status is SUCCEEDED. |
| error | ActualsError | false |  | Error description. Appears when actuals data export job failed (status is FAILED). |
| id | string | true |  | The ID of the actuals data export. |
| modelId | string | true |  | The ID of the model (or null if not specified). |
| onlyMatchedPredictions | boolean | false |  | If true, exports actuals with matching predictions only. |
| period | ActualsDataTimeRange | true |  | An actuals data time range definition. |
| status | string | true |  | An actuals data export processing state. |

### Enumerated Values

| Property | Value |
| --- | --- |
| status | [CANCELLED, CREATED, FAILED, SCHEDULED, SUCCEEDED] |

## ActualsDataTimeRange

```
{
  "description": "An actuals data time range definition.",
  "properties": {
    "end": {
      "description": "End of the period of actuals data to collect.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "start": {
      "description": "Start of the period of actuals data to collect.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "end",
    "start"
  ],
  "type": "object"
}
```

An actuals data time range definition.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| end | string(date-time) | true |  | End of the period of actuals data to collect. |
| start | string(date-time) | true |  | Start of the period of actuals data to collect. |

## ActualsDataUpdate

```
{
  "properties": {
    "status": {
      "description": "An actuals data export state overwrite value.",
      "enum": [
        "CANCELLED"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| status | string | false |  | An actuals data export state overwrite value. |

### Enumerated Values

| Property | Value |
| --- | --- |
| status | CANCELLED |

## ActualsError

```
{
  "description": "Error description. Appears when actuals data export job failed (status is FAILED).",
  "properties": {
    "message": {
      "description": "A human readable error message describing failure cause.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "message"
  ],
  "type": "object"
}
```

Error description. Appears when actuals data export job failed (status is FAILED).

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| message | string | true |  | A human readable error message describing failure cause. |

## ActualsExportCreatePayload

```
{
  "properties": {
    "end": {
      "description": "End of the period of actuals data to collect.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "modelId": {
      "description": "The ID of the model.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "onlyMatchedPredictions": {
      "default": true,
      "description": "If true, exports actuals with matching predictions only.",
      "type": "boolean",
      "x-versionadded": "v2.33"
    },
    "start": {
      "description": "Start of the period of actuals data to collect.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "end",
    "start"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| end | string(date-time) | true |  | End of the period of actuals data to collect. |
| modelId | string | false |  | The ID of the model. |
| onlyMatchedPredictions | boolean | false |  | If true, exports actuals with matching predictions only. |
| start | string(date-time) | true |  | Start of the period of actuals data to collect. |

## ActualsExportListResponse

```
{
  "properties": {
    "count": {
      "description": "Number of paginated entries.",
      "minimum": 0,
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "A list of asynchronous actuals data exports.",
      "items": {
        "properties": {
          "createdAt": {
            "description": "Actuals data export creation timestamp.",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "createdBy": {
            "description": "The user that created actuals data export.",
            "properties": {
              "id": {
                "description": "The ID of user who created actuals data export.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "id"
            ],
            "type": "object"
          },
          "data": {
            "description": "An actuals data export collected data entries. Available only when status is SUCCEEDED.",
            "items": {
              "properties": {
                "id": {
                  "description": "The ID of an entry.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                },
                "name": {
                  "description": "A name of an entry.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                }
              },
              "required": [
                "id",
                "name"
              ],
              "type": "object"
            },
            "type": "array",
            "x-versionadded": "v2.33"
          },
          "error": {
            "description": "Error description. Appears when actuals data export job failed (status is FAILED).",
            "properties": {
              "message": {
                "description": "A human readable error message describing failure cause.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "message"
            ],
            "type": "object"
          },
          "id": {
            "description": "The ID of the actuals data export.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "modelId": {
            "description": "The ID of the model (or null if not specified).",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "onlyMatchedPredictions": {
            "default": true,
            "description": "If true, exports actuals with matching predictions only.",
            "type": "boolean",
            "x-versionadded": "v2.33"
          },
          "period": {
            "description": "An actuals data time range definition.",
            "properties": {
              "end": {
                "description": "End of the period of actuals data to collect.",
                "format": "date-time",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "start": {
                "description": "Start of the period of actuals data to collect.",
                "format": "date-time",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "end",
              "start"
            ],
            "type": "object"
          },
          "status": {
            "description": "An actuals data export processing state.",
            "enum": [
              "CANCELLED",
              "CREATED",
              "FAILED",
              "SCHEDULED",
              "SUCCEEDED"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "createdAt",
          "createdBy",
          "id",
          "modelId",
          "period",
          "status"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "URL to the next page, or null if there is no such page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "URL to the previous page, or null if there is no such page",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "Total number of entries.",
      "minimum": 0,
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Properties

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

## ContextItem

```
{
  "properties": {
    "context": {
      "description": "Text generation context.",
      "type": "string"
    },
    "link": {
      "description": "Text generation context link.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "context"
  ],
  "type": "object",
  "x-versionadded": "v2.35"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| context | string | true |  | Text generation context. |
| link | string,null | false |  | Text generation context link. |

## DataQualityItem

```
{
  "properties": {
    "actualValue": {
      "description": "Actual value",
      "type": [
        "string",
        "null"
      ]
    },
    "associationId": {
      "description": "Association ID of prediction.",
      "type": "string"
    },
    "context": {
      "description": "A list of contexts used for text generation response.",
      "items": {
        "properties": {
          "context": {
            "description": "Text generation context.",
            "type": "string"
          },
          "link": {
            "description": "Text generation context link.",
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "context"
        ],
        "type": "object",
        "x-versionadded": "v2.35"
      },
      "maxItems": 10,
      "type": "array"
    },
    "metrics": {
      "description": "A list of collected metrics associated with the prediction instance.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the custom metric.",
            "type": "string"
          },
          "metadata": {
            "default": null,
            "description": "Custom metric value metadata.",
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.35"
          },
          "name": {
            "description": "Custom metric name.",
            "type": "string"
          },
          "value": {
            "description": "Custom metric value.",
            "oneOf": [
              {
                "type": "number"
              },
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "id",
          "name",
          "value"
        ],
        "type": "object",
        "x-versionadded": "v2.35"
      },
      "maxItems": 100,
      "type": "array"
    },
    "predictedValue": {
      "description": "Predicted value(s)",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "items": {
            "type": "string"
          },
          "maxItems": 100,
          "type": "array"
        },
        {
          "type": "null"
        }
      ]
    },
    "prompt": {
      "description": "Prompt for text generation target types.",
      "type": [
        "string",
        "null"
      ]
    },
    "timestamp": {
      "description": "Record creation timestamp.",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "actualValue",
    "associationId",
    "context",
    "metrics",
    "predictedValue",
    "prompt",
    "timestamp"
  ],
  "type": "object",
  "x-versionadded": "v2.35"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| actualValue | string,null | true |  | Actual value |
| associationId | string | true |  | Association ID of prediction. |
| context | [ContextItem] | true | maxItems: 10 | A list of contexts used for text generation response. |
| metrics | [MetricValue] | true | maxItems: 100 | A list of collected metrics associated with the prediction instance. |
| predictedValue | any | true |  | Predicted value(s) |

oneOf

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | string | false |  | none |

xor

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | [string] | false | maxItems: 100 | none |

xor

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | null | false |  | none |

continued

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| prompt | string,null | true |  | Prompt for text generation target types. |
| timestamp | string(date-time) | true |  | Record creation timestamp. |

## DataQualityResponse

```
{
  "properties": {
    "count": {
      "description": "Number of paginated entries.",
      "minimum": 0,
      "type": "integer"
    },
    "data": {
      "description": "A list of prediction data exports.",
      "items": {
        "properties": {
          "actualValue": {
            "description": "Actual value",
            "type": [
              "string",
              "null"
            ]
          },
          "associationId": {
            "description": "Association ID of prediction.",
            "type": "string"
          },
          "context": {
            "description": "A list of contexts used for text generation response.",
            "items": {
              "properties": {
                "context": {
                  "description": "Text generation context.",
                  "type": "string"
                },
                "link": {
                  "description": "Text generation context link.",
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "required": [
                "context"
              ],
              "type": "object",
              "x-versionadded": "v2.35"
            },
            "maxItems": 10,
            "type": "array"
          },
          "metrics": {
            "description": "A list of collected metrics associated with the prediction instance.",
            "items": {
              "properties": {
                "id": {
                  "description": "The ID of the custom metric.",
                  "type": "string"
                },
                "metadata": {
                  "default": null,
                  "description": "Custom metric value metadata.",
                  "type": [
                    "string",
                    "null"
                  ],
                  "x-versionadded": "v2.35"
                },
                "name": {
                  "description": "Custom metric name.",
                  "type": "string"
                },
                "value": {
                  "description": "Custom metric value.",
                  "oneOf": [
                    {
                      "type": "number"
                    },
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "id",
                "name",
                "value"
              ],
              "type": "object",
              "x-versionadded": "v2.35"
            },
            "maxItems": 100,
            "type": "array"
          },
          "predictedValue": {
            "description": "Predicted value(s)",
            "oneOf": [
              {
                "type": "string"
              },
              {
                "items": {
                  "type": "string"
                },
                "maxItems": 100,
                "type": "array"
              },
              {
                "type": "null"
              }
            ]
          },
          "prompt": {
            "description": "Prompt for text generation target types.",
            "type": [
              "string",
              "null"
            ]
          },
          "timestamp": {
            "description": "Record creation timestamp.",
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "actualValue",
          "associationId",
          "context",
          "metrics",
          "predictedValue",
          "prompt",
          "timestamp"
        ],
        "type": "object",
        "x-versionadded": "v2.35"
      },
      "maxItems": 100,
      "type": "array"
    },
    "next": {
      "description": "The URL to the next page, or null if there is no such page.",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL to the previous page, or null if there is no such page.",
      "type": [
        "string",
        "null"
      ]
    },
    "totalCount": {
      "description": "The total number of entries.",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object",
  "x-versionadded": "v2.35"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| count | integer | true | minimum: 0 | Number of paginated entries. |
| data | [DataQualityItem] | true | maxItems: 100 | A list of prediction data exports. |
| next | string,null | true |  | The URL to the next page, or null if there is no such page. |
| previous | string,null | true |  | The URL to the previous page, or null if there is no such page. |
| totalCount | integer | true | minimum: 0 | The total number of entries. |

## ExportCreatePayload

```
{
  "properties": {
    "augmentationType": {
      "default": "NO_AUGMENTATION",
      "description": "Indicates if prediction data is augmented with actuals or metrics",
      "enum": [
        "NO_AUGMENTATION",
        "ACTUALS_AND_METRICS"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "batchIds": {
      "description": "IDs of batches to export. Null for real-time data exports.",
      "items": {
        "type": "string"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "end": {
      "description": "End of the period of prediction data to collect. Defaults to now, or a week after the start time.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "modelId": {
      "description": "The ID of the model.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "start": {
      "description": "Start of the period of prediction data to collect. Defaults to a week before the end time.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| augmentationType | string,null | false |  | Indicates if prediction data is augmented with actuals or metrics |
| batchIds | [string] | false | maxItems: 100minItems: 1 | IDs of batches to export. Null for real-time data exports. |
| end | string(date-time) | false |  | End of the period of prediction data to collect. Defaults to now, or a week after the start time. |
| modelId | string | false |  | The ID of the model. |
| start | string(date-time) | false |  | Start of the period of prediction data to collect. Defaults to a week before the end time. |

### Enumerated Values

| Property | Value |
| --- | --- |
| augmentationType | [NO_AUGMENTATION, ACTUALS_AND_METRICS] |

## ExportEntity

```
{
  "properties": {
    "associationIds": {
      "description": "Association IDs of rows to export",
      "items": {
        "type": "string"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.35"
    },
    "augmentationType": {
      "default": "NO_AUGMENTATION",
      "description": "Indicates if prediction data is augmented with actuals or metrics",
      "enum": [
        "NO_AUGMENTATION",
        "ACTUALS_AND_METRICS"
      ],
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "batches": {
      "description": "Metadata associated with exported batch.",
      "items": {
        "properties": {
          "batchId": {
            "description": "An ID of a batch.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "batchName": {
            "description": "A name of a batch.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "batchId",
          "batchName"
        ],
        "type": "object"
      },
      "maxItems": 100,
      "minItems": 1,
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "createdAt": {
      "description": "Prediction data export creation timestamp.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "The user that created prediction data export.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "A prediction data export collected data entries. Available only when status is SUCCEEDED.",
      "items": {
        "properties": {
          "id": {
            "description": "The ID of the AI Catalog entry.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "name": {
            "description": "The name of the AI Catalog entry.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "error": {
      "description": "Error description. Appears when prediction data export job failed (status is FAILED).",
      "properties": {
        "message": {
          "description": "A human readable error message describing failure cause.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "message"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the prediction data export.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "modelId": {
      "description": "The ID of the model (or null if not specified).",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "period": {
      "description": "A prediction data time range definition.",
      "properties": {
        "end": {
          "description": "End of the period of prediction data to collect.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "start": {
          "description": "Start of the period of prediction data to collect.",
          "format": "date-time",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "end",
        "start"
      ],
      "type": "object"
    },
    "status": {
      "description": "A prediction data export processing state.",
      "enum": [
        "CANCELLED",
        "CREATED",
        "FAILED",
        "SCHEDULED",
        "SUCCEEDED"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "createdAt",
    "createdBy",
    "id",
    "modelId",
    "period",
    "status"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| associationIds | [string] | false | maxItems: 100minItems: 1 | Association IDs of rows to export |
| augmentationType | string,null | false |  | Indicates if prediction data is augmented with actuals or metrics |
| batches | [PredictionDataBatch] | false | maxItems: 100minItems: 1 | Metadata associated with exported batch. |
| createdAt | string(date-time) | true |  | Prediction data export creation timestamp. |
| createdBy | string | true |  | The user that created prediction data export. |
| data | [PredictionDataEntry] | false |  | A prediction data export collected data entries. Available only when status is SUCCEEDED. |
| error | ExportError | false |  | Error description. Appears when prediction data export job failed (status is FAILED). |
| id | string | true |  | The ID of the prediction data export. |
| modelId | string | true |  | The ID of the model (or null if not specified). |
| period | PredictionDataTimeRange | true |  | A prediction data time range definition. |
| status | string | true |  | A prediction data export processing state. |

### Enumerated Values

| Property | Value |
| --- | --- |
| augmentationType | [NO_AUGMENTATION, ACTUALS_AND_METRICS] |
| status | [CANCELLED, CREATED, FAILED, SCHEDULED, SUCCEEDED] |

## ExportError

```
{
  "description": "Error description. Appears when prediction data export job failed (status is FAILED).",
  "properties": {
    "message": {
      "description": "A human readable error message describing failure cause.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "message"
  ],
  "type": "object"
}
```

Error description. Appears when prediction data export job failed (status is FAILED).

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| message | string | true |  | A human readable error message describing failure cause. |

## MetricValue

```
{
  "properties": {
    "id": {
      "description": "The ID of the custom metric.",
      "type": "string"
    },
    "metadata": {
      "default": null,
      "description": "Custom metric value metadata.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.35"
    },
    "name": {
      "description": "Custom metric name.",
      "type": "string"
    },
    "value": {
      "description": "Custom metric value.",
      "oneOf": [
        {
          "type": "number"
        },
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "id",
    "name",
    "value"
  ],
  "type": "object",
  "x-versionadded": "v2.35"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| id | string | true |  | The ID of the custom metric. |
| metadata | string,null | false |  | Custom metric value metadata. |
| name | string | true |  | Custom metric name. |
| value | any | true |  | Custom metric value. |

oneOf

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | number | false |  | none |

xor

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | string | false |  | none |

xor

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | null | false |  | none |

## PredictionDataBatch

```
{
  "properties": {
    "batchId": {
      "description": "An ID of a batch.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "batchName": {
      "description": "A name of a batch.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "batchId",
    "batchName"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| batchId | string | true |  | An ID of a batch. |
| batchName | string | true |  | A name of a batch. |

## PredictionDataEntry

```
{
  "properties": {
    "id": {
      "description": "The ID of the AI Catalog entry.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the AI Catalog entry.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| id | string | true |  | The ID of the AI Catalog entry. |
| name | string | true |  | The name of the AI Catalog entry. |

## PredictionDataTimeRange

```
{
  "description": "A prediction data time range definition.",
  "properties": {
    "end": {
      "description": "End of the period of prediction data to collect.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "start": {
      "description": "Start of the period of prediction data to collect.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "end",
    "start"
  ],
  "type": "object"
}
```

A prediction data time range definition.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| end | string(date-time) | true |  | End of the period of prediction data to collect. |
| start | string(date-time) | true |  | Start of the period of prediction data to collect. |

## PredictionDataUpdate

```
{
  "properties": {
    "status": {
      "description": "A prediction data export processing state.",
      "enum": [
        "CANCELLED"
      ],
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| status | string | false |  | A prediction data export processing state. |

### Enumerated Values

| Property | Value |
| --- | --- |
| status | CANCELLED |

## PredictionExportListResponse

```
{
  "properties": {
    "count": {
      "description": "Number of paginated entries.",
      "minimum": 0,
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "A list of prediction data exports.",
      "items": {
        "properties": {
          "associationIds": {
            "description": "Association IDs of rows to export",
            "items": {
              "type": "string"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array",
            "x-versionadded": "v2.35"
          },
          "augmentationType": {
            "default": "NO_AUGMENTATION",
            "description": "Indicates if prediction data is augmented with actuals or metrics",
            "enum": [
              "NO_AUGMENTATION",
              "ACTUALS_AND_METRICS"
            ],
            "type": [
              "string",
              "null"
            ],
            "x-versionadded": "v2.33"
          },
          "batches": {
            "description": "Metadata associated with exported batch.",
            "items": {
              "properties": {
                "batchId": {
                  "description": "An ID of a batch.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                },
                "batchName": {
                  "description": "A name of a batch.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                }
              },
              "required": [
                "batchId",
                "batchName"
              ],
              "type": "object"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array",
            "x-versionadded": "v2.33"
          },
          "createdAt": {
            "description": "Prediction data export creation timestamp.",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "createdBy": {
            "description": "The user that created prediction data export.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "data": {
            "description": "A prediction data export collected data entries. Available only when status is SUCCEEDED.",
            "items": {
              "properties": {
                "id": {
                  "description": "The ID of the AI Catalog entry.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                },
                "name": {
                  "description": "The name of the AI Catalog entry.",
                  "type": "string",
                  "x-versionadded": "v2.33"
                }
              },
              "required": [
                "id",
                "name"
              ],
              "type": "object"
            },
            "type": "array",
            "x-versionadded": "v2.33"
          },
          "error": {
            "description": "Error description. Appears when prediction data export job failed (status is FAILED).",
            "properties": {
              "message": {
                "description": "A human readable error message describing failure cause.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "message"
            ],
            "type": "object"
          },
          "id": {
            "description": "The ID of the prediction data export.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "modelId": {
            "description": "The ID of the model (or null if not specified).",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "period": {
            "description": "A prediction data time range definition.",
            "properties": {
              "end": {
                "description": "End of the period of prediction data to collect.",
                "format": "date-time",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "start": {
                "description": "Start of the period of prediction data to collect.",
                "format": "date-time",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "end",
              "start"
            ],
            "type": "object"
          },
          "status": {
            "description": "A prediction data export processing state.",
            "enum": [
              "CANCELLED",
              "CREATED",
              "FAILED",
              "SCHEDULED",
              "SUCCEEDED"
            ],
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "createdAt",
          "createdBy",
          "id",
          "modelId",
          "period",
          "status"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "URL to the next page, or null if there is no such page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "URL to the previous page, or null if there is no such page",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "Total number of entries.",
      "minimum": 0,
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Properties

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

## PredictionResultResponse

```
{
  "properties": {
    "actual": {
      "description": "Actual value of the prediction",
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "number"
        },
        {
          "type": "string"
        }
      ]
    },
    "associationId": {
      "description": "Association id of the prediction, which is used to associate a prediction with its actual value and calculate accuracy.",
      "type": "string"
    },
    "forecastDistance": {
      "description": "The number of time units this prediction is away from the forecastPoint. The unit of time is determined by the timeUnit of the datetime partition column. For time series models only.",
      "type": [
        "integer",
        "null"
      ],
      "x-versionadded": "v2.23"
    },
    "modelId": {
      "description": "ID of the model used to make these predictions",
      "type": "string"
    },
    "predicted": {
      "description": "Predicted value of the prediction",
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "number"
        },
        {
          "type": "string"
        }
      ]
    },
    "timestamp": {
      "description": "When the prediction was made.",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "actual",
    "associationId",
    "modelId",
    "predicted",
    "timestamp"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| actual | any | true |  | Actual value of the prediction |

oneOf

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | integer | false |  | none |

xor

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | number | false |  | none |

xor

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | string | false |  | none |

continued

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| associationId | string | true |  | Association id of the prediction, which is used to associate a prediction with its actual value and calculate accuracy. |
| forecastDistance | integer,null | false |  | The number of time units this prediction is away from the forecastPoint. The unit of time is determined by the timeUnit of the datetime partition column. For time series models only. |
| modelId | string | true |  | ID of the model used to make these predictions |
| predicted | any | true |  | Predicted value of the prediction |

oneOf

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | integer | false |  | none |

xor

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | number | false |  | none |

xor

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| » anonymous | string | false |  | none |

continued

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| timestamp | string(date-time) | true |  | When the prediction was made. |

## PredictionResultsListResponse

```
{
  "properties": {
    "associationIdColumnNames": {
      "description": "List of column names used to represent an association id, which is used to unique identify individual prediction rows.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "count": {
      "description": "The number of items returned on this page.",
      "type": "integer"
    },
    "data": {
      "description": "An array of prediction requests.",
      "items": {
        "properties": {
          "actual": {
            "description": "Actual value of the prediction",
            "oneOf": [
              {
                "type": "integer"
              },
              {
                "type": "number"
              },
              {
                "type": "string"
              }
            ]
          },
          "associationId": {
            "description": "Association id of the prediction, which is used to associate a prediction with its actual value and calculate accuracy.",
            "type": "string"
          },
          "forecastDistance": {
            "description": "The number of time units this prediction is away from the forecastPoint. The unit of time is determined by the timeUnit of the datetime partition column. For time series models only.",
            "type": [
              "integer",
              "null"
            ],
            "x-versionadded": "v2.23"
          },
          "modelId": {
            "description": "ID of the model used to make these predictions",
            "type": "string"
          },
          "predicted": {
            "description": "Predicted value of the prediction",
            "oneOf": [
              {
                "type": "integer"
              },
              {
                "type": "number"
              },
              {
                "type": "string"
              }
            ]
          },
          "timestamp": {
            "description": "When the prediction was made.",
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "actual",
          "associationId",
          "modelId",
          "predicted",
          "timestamp"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "next": {
      "description": "The URL of the next page (if null, there is no next page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    },
    "previous": {
      "description": "The URL of the previous page (if null, there is no previous page).",
      "format": "uri",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "associationIdColumnNames",
    "data",
    "next",
    "previous"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| associationIdColumnNames | [string] | true |  | List of column names used to represent an association id, which is used to unique identify individual prediction rows. |
| count | integer | false |  | The number of items returned on this page. |
| data | [PredictionResultResponse] | true |  | An array of prediction requests. |
| next | string,null(uri) | true |  | The URL of the next page (if null, there is no next page). |
| previous | string,null(uri) | true |  | The URL of the previous page (if null, there is no previous page). |

## TrainingDataEntry

```
{
  "description": "A training data entry.",
  "properties": {
    "id": {
      "description": "The ID of the AI Catalog entry.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "name": {
      "description": "The name of the AI Catalog entry.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "type": "object"
}
```

A training data entry.

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| id | string | true |  | The ID of the AI Catalog entry. |
| name | string | true |  | The name of the AI Catalog entry. |

## TrainingDataExportCreatePayload

```
{
  "properties": {
    "modelId": {
      "default": null,
      "description": "(Optional) The ID of the model.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    }
  },
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| modelId | string,null | false |  | (Optional) The ID of the model. |

## TrainingDataExportEntity

```
{
  "properties": {
    "createdAt": {
      "description": "Training data export creation timestamp.",
      "format": "date-time",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "createdBy": {
      "description": "The user who created the training data export.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "A training data entry.",
      "properties": {
        "id": {
          "description": "The ID of the AI Catalog entry.",
          "type": "string",
          "x-versionadded": "v2.33"
        },
        "name": {
          "description": "The name of the AI Catalog entry.",
          "type": "string",
          "x-versionadded": "v2.33"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "id": {
      "description": "The ID of the training data export.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "modelId": {
      "description": "The ID of the model.",
      "type": "string",
      "x-versionadded": "v2.33"
    },
    "modelPackageId": {
      "description": "The ID of the related model package.",
      "type": "string",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "createdAt",
    "createdBy",
    "data",
    "id",
    "modelId",
    "modelPackageId"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| createdAt | string(date-time) | true |  | Training data export creation timestamp. |
| createdBy | string | true |  | The user who created the training data export. |
| data | TrainingDataEntry | true |  | A training data entry. |
| id | string | true |  | The ID of the training data export. |
| modelId | string | true |  | The ID of the model. |
| modelPackageId | string | true |  | The ID of the related model package. |

## TrainingDataExportListResponse

```
{
  "properties": {
    "count": {
      "description": "Number of paginated entries.",
      "minimum": 0,
      "type": "integer",
      "x-versionadded": "v2.33"
    },
    "data": {
      "description": "The list of training data exports.",
      "items": {
        "properties": {
          "createdAt": {
            "description": "Training data export creation timestamp.",
            "format": "date-time",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "createdBy": {
            "description": "The user who created the training data export.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "data": {
            "description": "A training data entry.",
            "properties": {
              "id": {
                "description": "The ID of the AI Catalog entry.",
                "type": "string",
                "x-versionadded": "v2.33"
              },
              "name": {
                "description": "The name of the AI Catalog entry.",
                "type": "string",
                "x-versionadded": "v2.33"
              }
            },
            "required": [
              "id",
              "name"
            ],
            "type": "object"
          },
          "id": {
            "description": "The ID of the training data export.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "modelId": {
            "description": "The ID of the model.",
            "type": "string",
            "x-versionadded": "v2.33"
          },
          "modelPackageId": {
            "description": "The ID of the related model package.",
            "type": "string",
            "x-versionadded": "v2.33"
          }
        },
        "required": [
          "createdAt",
          "createdBy",
          "data",
          "id",
          "modelId",
          "modelPackageId"
        ],
        "type": "object"
      },
      "type": "array",
      "x-versionadded": "v2.33"
    },
    "next": {
      "description": "URL to the next page, or null if there is no such page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "previous": {
      "description": "URL to the previous page, or null if there is no such page.",
      "type": [
        "string",
        "null"
      ],
      "x-versionadded": "v2.33"
    },
    "totalCount": {
      "description": "Total number of entries.",
      "minimum": 0,
      "type": "integer",
      "x-versionadded": "v2.33"
    }
  },
  "required": [
    "count",
    "data",
    "next",
    "previous",
    "totalCount"
  ],
  "type": "object"
}
```

### Properties

| Name | Type | Required | Restrictions | Description |
| --- | --- | --- | --- | --- |
| count | integer | true | minimum: 0 | Number of paginated entries. |
| data | [TrainingDataExportEntity] | true |  | The list of training data exports. |
| 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. |

---
