Report results

Use the Solution Reporting API to retrieve report results and access rich metadata about each run, including status, timestamps, record counts, and per-file outputs with pre-signed download URLs. The Report Results endpoints let developers list results globally or for a specific report definition, filter by attributes like status or creation date, fetch a single result by ID, and trigger a new run of a report definition to generate fresh outputs for downstream automation.

Base URL:

https://platform-reporting.vertexcloud.com/api/v1/reports
Report results endpointReport results endpoint description
/reports/{reportId}/resultsGET - Retrieve all report results generated for a specific report definition.
/reports/results/{reportResultId}GET - Retrieve full metadata for a single report result by its ID, including a pre-signed download URL.
/reports/{reportId}/results/{reportResultId}GET - Retrieve full metadata for a single report result, including any pre-signed download URLs.
/reports/resultsGET - Retrieve a list of report results across all report definitions.
/reports/results/{reportResultId}DELETE - Hard-delete a report result and its generated artifact. The operation is idempotent and returns a 204 No Content HTTP status code when the result has already been deleted.
/reports/results/{reportResultId}/cancelPOST - Request cancelation of a report result that is currently PENDING or PROCESSING. The operation is idempotent — repeating it for an already-canceled result returns a 204 No Content HTTP status code. Results in COMPLETED or FAILED status cannot be canceled and return a 409 Conflict HTTP status code.

List report results for a report definition

Retrieve all report results generated for a specific report definition, with optional filters for status, name, and creation date range.

Request URL:

https://platform-reporting.vertexcloud.com/api/v1/reports/{reportId}/results

List report results for a report definition request

All query parameters for this endpoint are optional; the required path parameter reportId determines which report definition the API returns results for.

Parameter nameParameter formatParameter description
reportId RequireduuidUUID of the report definition.
statusstring enumFilter by report result status. Allowed: PENDING, PROCESSING, STORING, COMPLETED, CANCELED, FAILED.
createDateFromdate, ISO-8601ISO-8601 creation start date (inclusive).
createDateTodate, ISO-8601ISO-8601 creation end date (inclusive).
namestringFilter by report result name (case-insensitive substring match).
offsetintegerNumber of items to skip (for pagination).
Must be greater than or equal to 0. Defaults to 0.
limitintegerMaximum number of items to return.
Must be between 1 to 500. Defaults to 25.
sortBystring enumField to sort by. Allowed: NAME, TEMPLATE_NAME, CATEGORY_NAME, CREATED_AT, FINISH_DATE_TIME, STATUS.
Defaults to CREATED_AT.
sortOrderstring enumSort direction. Allowed: ASC or DESC.
Defaults to ASC.

List report results for a report definition request example

curl --request GET \
     --url 'https://platform-reporting.vertexcloud.com/api/v1/reports/f81d4fae-7dec-11d0-a765-00a0c91e6bf6/results?status=COMPLETED' \
     --header 'accept: application/json'

List report results for a report definition response

The API wraps the results in an envelope with these top-level response fields.

Response fieldTypeDescription
countintegerTotal number of report results for the specified definition.
Must be greater than or equal to 0.
offsetintegerNumber of items skipped.
Must be greater than or equal to 0.
limitintegerMaximum items per page.
Must be greater than or equal to 1.
valuearray of objectsArray of ReportResultDetails objects.

The following table lists the fields you receive inside each item in the value[] array.

Response fieldTypeDescription
reportResultIduuidUnique identifier of this report result.
reportResultNamestringHuman-readable name of this report result
reportIduuid | nullIdentifier of the underlying report definition, if available.
reportNamestringHuman‑readable name of the underlying report definition, if available.
templateIduuidUUID of the template used for this execution.
templateNamestringName of the report template.
templateDisplayNamestringDisplay name of the report template.
categoryobject | nullReport category.
Contains: id (UUID) and name (string)
createDateTimedate-timeDate and time when the report run started.
finishDateTimedate-timeDate and time when the report run finished, if completed.
statusstring enumCurrent processing state of the report result. Allowed: PENDING, PROCESSING, STORING, COMPLETED, CANCELED, FAILED.
errorobject | nullError details for a failed report result.
processedRecordCountint32 | nullNumber of records processed in this report execution, if available.
scheduleIduuid | nullUnique identifier of the schedule that triggered the execution; null for manual runs.
outputobject | nullMetadata for the generated artifact, without a download URL.

List report results for a report definition response error objects

Response fieldTypeDescription
codestring enumClassification code indicating why the report generation failed: WORKFLOW_START_FAILED, WORKFLOW_GENERAL_FAILURE, STORAGE_WORKFLOW_FAILED, STORAGE_WORKFLOW_ERROR, REPORT_RESULT_INVALID_STATE, REPORT_RESULT_NOT_FOUND, STANDARD_REPORT_GENERATION_FAILED, STANDARD_REPORT_FILTER_LOAD_FAILED, STANDARD_REPORT_TEMPLATE_LOAD_FAILED, DATA_EXTRACT_REPORT_GENERATION_FAILED, DATA_EXTRACT_REPORT_DEFINITION_LOAD_FAILED.
messagestring | nullDetailed error message describing what went wrong during report generation.

List report results for a report definition response output objects

Response fieldTypeDescription
fileNamestringName of the generated output file.
fileSizeint64Size of the generated output file in bytes.
formatstring enumFile format of the generated report: CSV, HTML, PDF, RTF, XML, XLS, XLSX, TXT.
compressionstring | null enumCompression applied to the generated file content.
null - no compression
ZIP - ZIP archive
GZIP - GZIP stream

List report results for a report definition response example

{
  "count": 0,
  "offset": 0,
  "limit": 0,
  "value": [
    {
      "reportResultId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reportResultName": "string",
      "reportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reportName": "string",
      "templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "templateName": "string",
      "templateDisplayName": "string",
      "category": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      },
      "createDateTime": "2026-06-10T18:41:32.502Z",
      "finishDateTime": "2026-06-10T18:41:32.502Z",
      "status": "COMPLETED",
      "error": {
        "code": "WORKFLOW_START_FAILED",
        "message": "string"
      },
      "processedRecordCount": 0,
      "output": {
        "fileName": "string",
        "fileSize": 0,
        "format": "CSV",
        "compression": "GZIP"
      }
    }
  ]
}

Get report result details by result ID only

Retrieve full metadata for a single report result by its ID, including a pre-signed download URL.

Request URL:

https://platform-reporting.vertexcloud.com/api/v1/reports/results/{reportResultId}

Get report result details by result ID only request

The reportResultId path parameter for this endpoint is required.

Parameter nameParameter formatParameter description
reportResultId RequireduuidUUID of the report result.

Get report result details by result ID only request example

curl --request GET \
     --url https://platform-reporting.vertexcloud.com/api/v1/reports/results/a72d44be-52c0-4f9f-9e84-0f6b32c8c5dd \
     --header 'accept: application/json'

Get report result details by result ID only response

The following table lists the fields you receive as a response to the Get report result details by result ID only request.

Response fieldTypeDescription
reportResultIduuidUnique identifier for the report result.
reportResultNamestringHuman‑readable name of the report run.
reportIduuid | nullIdentifier of the underlying report definition, if available.
reportNamestring | nullName of the underlying report definition, if available.
templateIduuidUUID of the template used for this execution.
templateNamestringName of the report template.
templateDisplayNamestringDisplay name of the report template.
categoryobject | nullReport category.
Contains: id (UUID) and name (string)
createDateTimedate-timeDate and time when the report run started.
finishDateTimedate-timeDate and time when the report run finished, if completed.
statusstring enumCurrent processing state of the report result. Allowed: PENDING, PROCESSING, STORING,COMPLETED, FAILED, CANCELED.
errorobject | nullError details for a failed report result.
processedRecordCountint32 | nullNumber of records processed in this report execution, if available.
scheduleIduuid | nullUnique identifier of the schedule that triggered the execution; null for manual runs.
outputobject | nullMetadata for the generated artifact, without a download URL.

Get report result details by result ID only response error objects

Response fieldTypeDescription
codestring enumClassification code indicating why the report generation failed: WORKFLOW_START_FAILED, WORKFLOW_GENERAL_FAILURE, STORAGE_WORKFLOW_FAILED, STORAGE_WORKFLOW_ERROR, REPORT_RESULT_INVALID_STATE, REPORT_RESULT_NOT_FOUND, STANDARD_REPORT_GENERATION_FAILED, STANDARD_REPORT_FILTER_LOAD_FAILED, STANDARD_REPORT_TEMPLATE_LOAD_FAILED, DATA_EXTRACT_REPORT_GENERATION_FAILED, DATA_EXTRACT_REPORT_DEFINITION_LOAD_FAILED.
messagestring | nullDetailed error message describing what went wrong during report generation.

Get report result details by result ID only response output objects

Response fieldTypeDescription
fileNamestringName of the generated output file.
fileSizeint64Size of the generated output file in bytes.
formatstring enumFile format of the generated report: CSV, HTML, PDF, RTF, XML, XLS, XLSX, TXT.
compressionstring | null enumCompression applied to the generated file content.
null - no compression
ZIP - ZIP archive
GZIP - GZIP stream
reportUrluriURL for downloading the generated report file.

Get report result details by result ID only response example

{
  "reportResultId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reportResultName": "string",
  "reportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reportName": "string",
  "templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "templateName": "string",
  "templateDisplayName": "string",
  "category": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "createDateTime": "2026-06-11T03:01:02.893Z",
  "finishDateTime": "2026-06-11T03:01:02.893Z",
  "status": "COMPLETED",
  "error": {
    "code": "WORKFLOW_START_FAILED",
    "message": "string"
  },
  "processedRecordCount": 0,
  "output": {
    "fileName": "string",
    "fileSize": 0,
    "format": "CSV",
    "compression": "GZIP",
    "reportUrl": "string"
  }
}

Get report result details by definition and result ID

Retrieve full metadata for a single report result, including any pre-signed download URLs.

Request URL:

https://platform-reporting.vertexcloud.com/api/v1/reports/{reportId}/results/{reportResultId}

Get report result details by definition and result ID request

Both path parameters for this endpoint are required.

Parameter nameParameter formatParameter description
reportId RequireduuidUUID of the report definition.
reportResultId RequireduuidUUID of the report result.

Get report result details by definition and result ID request example

curl --request GET \
     --url https://platform-reporting.vertexcloud.com/api/v1/reports/3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712/results/a72d44be-52c0-4f9f-9e84-0f6b32c8c5dd \
     --header 'accept: application/json'

Get report result details by definition and result ID response

The following table lists the fields you receive as a response to the Get report result details by definition and result ID request.

Response fieldTypeDescription
reportResultIduuidUnique identifier for the report result.
reportResultNamestringHuman‑readable name of the report run.
reportIduuid | nullIdentifier of the underlying report definition, if available.
reportNamestring | nullName of the underlying report definition, if available.
templateIduuidUUID of the template used for this execution.
templateNamestringName of the report template.
templateDisplayNamestringDisplay name of the report template.
categoryobject | nullReport category.
Contains: id (UUID) and name (string)
createDateTimedate-timeDate and time when the report run started.
finishDateTimedate-timeDate and time when the report run finished, if completed.
statusstring enumCurrent processing state of the report result. Allowed: PENDING, PROCESSING, STORING,COMPLETED, FAILED, CANCELED.
errorobject | nullError details for a failed report result.
processedRecordCountint32 | nullNumber of records processed in this report execution, if available.
outputobject | nullMetadata for the generated artifact, without a download URL.

Get report result details by definition and result ID response error objects

Response fieldTypeDescription
codestring enumClassification code indicating why the report generation failed: WORKFLOW_START_FAILED, WORKFLOW_GENERAL_FAILURE, STORAGE_WORKFLOW_FAILED, STORAGE_WORKFLOW_ERROR, REPORT_RESULT_INVALID_STATE, REPORT_RESULT_NOT_FOUND, STANDARD_REPORT_GENERATION_FAILED, STANDARD_REPORT_FILTER_LOAD_FAILED, STANDARD_REPORT_TEMPLATE_LOAD_FAILED, DATA_EXTRACT_REPORT_GENERATION_FAILED, DATA_EXTRACT_REPORT_DEFINITION_LOAD_FAILED.
messagestring | nullDetailed error message describing what went wrong during report generation.

Get report result details by definition and result ID response output objects

Response fieldTypeDescription
fileNamestringName of the generated output file.
fileSizeint64Size of the generated output file in bytes.
formatstring enumFile format of the generated report: CSV, HTML, PDF, RTF, XML, XLS, XLSX, TXT.
compressionstring | null enumCompression applied to the generated file content.
null - no compression
ZIP - ZIP archive
GZIP - GZIP stream
reportUrluriURL for downloading the generated report file.

Get report result details by definition and result ID response example

{
  "reportResultId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reportResultName": "string",
  "reportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reportName": "string",
  "templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "templateName": "string",
  "templateDisplayName": "string",
  "category": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "createDateTime": "2026-06-11T03:01:02.893Z",
  "finishDateTime": "2026-06-11T03:01:02.893Z",
  "status": "COMPLETED",
  "error": {
    "code": "WORKFLOW_START_FAILED",
    "message": "string"
  },
  "processedRecordCount": 0,
  "output": {
    "fileName": "string",
    "fileSize": 0,
    "format": "CSV",
    "compression": "GZIP",
    "reportUrl": "string"
  }
}

List report results

Retrieve a list of report results across all report definitions, optionally filtered by definition, template, category, status, name, and creation date range.

Request URL:

https://platform-reporting.vertexcloud.com/api/v1/reports/results

List report results request

All query parameters for this endpoint are optional.

Parameter nameParameter formatParameter description
templateIdarray of uuidsFilter by template UUID(s). Multiple values are combined as a union. When used together with categoryId, only templates present in both filters are returned (intersection).
templateTypearray of objectsFilter by template type(s). When used with templateId / categoryId, narrows the result to only templates of matching type (intersection).
categoryIdarray of uuidsFilter by report category UUID(s). Resolved to template UUIDs belonging to the category. Multiple category values are unioned. When used together with templateId, only templates present in both filters are returned (intersection).
statusarray of objectsFilter by report result status(es). Multiple values are combined as a union (results matching any of the given statuses are returned). Allowed: PENDING, PROCESSING, STORING, COMPLETED, CANCELED, FAILED.
formatarray of objectsFilter by report output format(s). Multiple values are combined as a union. Results matching any of the given formats are returned.
namestringFilter by report result name (case-insensitive substring match).
createDateFromdate, ISO-8601Return only report results created on or after the specified date (inclusive).
createDateTodate, ISO-8601Return only report results created on or before the specified date (inclusive).
offsetintegerNumber of items to skip (for pagination).
Must be greater than or equal to 0. Defaults to 0.
limitintegerMaximum number of items to return.
Must be between 1 to 500. Defaults to 25.
sortBystring enumField to sort by. Allowed: NAME, TEMPLATE_NAME, CATEGORY_NAME, CREATED_AT, FINISH_DATE_TIME, STATUS.
Defaults to CREATED_AT.
sortOrderstring enumSort direction. Allowed: ASC or DESC.
Defaults to ASC.

List report results request example

curl --request GET \
     --url 'https://platform-reporting.vertexcloud.com/api/v1/reports/results?templateId=3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712&status=COMPLETED' \
     --header 'accept: application/json'

List report results response

The API wraps the results in an envelope with these top-level response fields.

Response fieldTypeDescription
countintegerTotal number of report results for the specified definition.
offsetintegerNumber of items skipped.
limitintegerMaximum items per page.
valuearrayArray of ReportResultDetails objects.

The fields you receive as a response to the List report results request.

Response fieldTypeDescription
reportResultIduuidUnique identifier of this report result.
reportResultNamestringHuman-readable name of this report result.
reportIduuidIdentifier of the underlying report definition, if available
reportNamestringName of the underlying report definition, if available
templateIduuidUnique identifier of the template used for the execution.
templateNamestringName of the template used for the execution.
templateDisplayNamestringDisplay name of the report template.
categoryobject | nullReport category.
Contains: id (UUID) and name (string)
createDateTimedate-timeDate and time when the report run started.
finishDateTimedate-timeDate and time when the report run finished, if completed.
statusstring enumCurrent processing state of the report result. Allowed: PENDING, PROCESSING, STORING, COMPLETED, CANCELED, FAILED.
errorobject | nullError details for a failed report result.
processedRecordCountint32 | nullNumber of records processed in this report execution, if available.
outputobject | nullMetadata for the generated artifact, without a download URL.

List report results response error objects

Response fieldTypeDescription
codestring enumClassification code indicating why the report generation failed: WORKFLOW_START_FAILED, WORKFLOW_GENERAL_FAILURE, STORAGE_WORKFLOW_FAILED, STORAGE_WORKFLOW_ERROR, REPORT_RESULT_INVALID_STATE, REPORT_RESULT_NOT_FOUND, STANDARD_REPORT_GENERATION_FAILED, STANDARD_REPORT_FILTER_LOAD_FAILED, STANDARD_REPORT_TEMPLATE_LOAD_FAILED, DATA_EXTRACT_REPORT_GENERATION_FAILED, DATA_EXTRACT_REPORT_DEFINITION_LOAD_FAILED.
messagestring | nullDetailed error message describing what went wrong during report generation.

List report results response output objects

Response fieldTypeDescription
fileNamestringName of the generated output file.
fileSizeint64Size of the generated output file in bytes.
formatstring enumFile format of the generated report: CSV, HTML, PDF, RTF, XML, XLS, XLSX, TXT.
compressionstring | null enumCompression applied to the generated file content.
null - no compression
ZIP - ZIP archive
GZIP - GZIP stream

List report results response example

{
  "count": 0,
  "offset": 0,
  "limit": 0,
  "value": [
    {
      "reportResultId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reportResultName": "string",
      "reportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reportName": "string",
      "templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "templateName": "string",
      "templateDisplayName": "string",
      "category": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      },
      "createDateTime": "2026-06-11T03:01:02.893Z",
      "finishDateTime": "2026-06-11T03:01:02.893Z",
      "status": "COMPLETED",
      "error": {
        "code": "WORKFLOW_START_FAILED",
        "message": "string"
      },
      "processedRecordCount": 0,
      "output": {
        "fileName": "string",
        "fileSize": 0,
        "format": "CSV",
        "compression": "GZIP"
      }
    }
  ]
}

Delete report result

Hard-delete a report result and its generated artifact. The operation is idempotent and returns a 204 No Content HTTP status code indicating that the request succeeded, even if the definition is already archived.

Request URL:

https://platform-reporting.vertexcloud.com/api/v1/reports/results/{reportResultId}

Delete report result request

Parameter nameParameter formatParameter description
reportResultId RequireduuidUUID of the report result.

Delete report result request example

curl --request DELETE \
     --url https://platform-reporting.vertexcloud.com/api/v1/reports/results/3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712 \
     --header 'accept: application/json'

Delete report result response

Report result deleted successfully or it no longer exists.

A 204 No Content HTTP status code indicates that the request succeeded. There is no other content or message body.

Cancel report execution

Request cancelation of a report result that is currently PENDING or PROCESSING. The operation is idempotent — repeating it for an already-canceled result returns 204 No Content HTTP status code. Results in COMPLETED or FAILED status cannot be canceled and return a 409 Conflict HTTP status code.

Request URL:

https://platform-reporting.vertexcloud.com/api/v1/reports/results/{reportResultId}/cancel

Cancel report execution request

Parameter nameParameter formatParameter description
reportResultId RequireduuidUUID of the report result.

Cancel report execution request example

curl --request POST \
     --url https://platform-reporting.vertexcloud.com/api/v1/reports/results/3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712/cancel \
     --header 'accept: application/json'

Cancel report execution response

Report result canceled successfully.

Response fieldTypeDescription
reportResultIduuidUnique identifier of this report result.
reportResultNamestringHuman-readable name of this report result.
reportIduuid | nullUnique identifier for the report result.
reportNamestring | nullHuman‑readable name of the report run.
templateIduuidUnique identifier of the template used for the execution.
templateNamestringName of the template used for the execution.
templateDisplayNamestringDisplay name of the report template.
categoryobject | nullReport category.
Contains: id (UUID) and name (string)
createDateTimedate-timeDate and time when the report run started.
finishDateTimedate-timeDate and time when the report run finished, if completed.
statusstring enumCurrent processing state of the report result. Allowed: PENDING, PROCESSING, STORING,COMPLETED, FAILED, CANCELED.
errorobject | nullError details for a failed report result.
processedRecordCountint32 | nullNumber of records processed in this report execution, if available.
outputobject | nullMetadata for the generated artifact, without a download URL.

Cancel report execution response error objects

Response fieldTypeDescription
codestring enumClassification code indicating why the report generation failed: WORKFLOW_START_FAILED, WORKFLOW_GENERAL_FAILURE, STORAGE_WORKFLOW_FAILED, STORAGE_WORKFLOW_ERROR, REPORT_RESULT_INVALID_STATE, REPORT_RESULT_NOT_FOUND, STANDARD_REPORT_GENERATION_FAILED, STANDARD_REPORT_FILTER_LOAD_FAILED, STANDARD_REPORT_TEMPLATE_LOAD_FAILED, DATA_EXTRACT_REPORT_GENERATION_FAILED, DATA_EXTRACT_REPORT_DEFINITION_LOAD_FAILED.
messagestring | nullDetailed error message describing what went wrong during report generation.

Cancel report execution response output objects

Response fieldTypeDescription
fileNamestringName of the generated output file.
fileSizeint64Size of the generated output file in bytes.
formatstring enumFile format of the generated report: CSV, HTML, PDF, RTF, XML, XLS, XLSX, TXT.
compressionstring | null enumCompression applied to the generated file content.
null - no compression
ZIP - ZIP archive
GZIP - GZIP stream

Cancel report execution response example

{
  "reportResultId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reportResultName": "string",
  "reportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reportName": "string",
  "templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "templateName": "string",
  "templateDisplayName": "string",
  "category": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "createDateTime": "2026-06-11T03:01:02.893Z",
  "finishDateTime": "2026-06-11T03:01:02.893Z",
  "status": "COMPLETED",
  "error": {
    "code": "WORKFLOW_START_FAILED",
    "message": "string"
  },
  "processedRecordCount": 0,
  "output": {
    "fileName": "string",
    "fileSize": 0,
    "format": "CSV",
    "compression": "GZIP"
  }
}