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 endpoint	Endpoint description
`/reports/{reportId}/results`	GET - Retrieve all report results generated for a specific report definition.
`/reports/{definitionId}/results/{reportResultId}`	GET - Retrieve full metadata for a single report result, including any pre-signed download URLs.
`/reports/results`	GET - Retrieve a list of report results across all report definitions.
`/reports/results/{reportResultId}`	GET - Retrieve full metadata for a single report result by its ID, including pre-signed download URL.

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

Request

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

Parameter name	Parameter format	Parameter description
`reportId`	uuid	Required. Unique ID of the report definition.
`status`	string enum	Filter by report result status. • PENDING • PROCESSING • COMPLETED • CANCELLED • FAILED
`createDateFrom`	date, ISO-8601	ISO-8601 creation start date (inclusive).
`createDateTo`	date, ISO-8601	ISO-8601 creation end date (inclusive).
`name`	string	Filter by report result name (case-insensitive substring match).

Example request

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

Response

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

Response field	Type	Description
`count`	integer	Total number of report results for the specified definition.
`value`	array	Array of `ReportResultDetails` objects.

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

Response field	Type	Description
`reportId`	uuid	Unique identifier for the report result.
`reportName`	string	Human‑readable name of the report run.
`definitionId`	uuid \| null	Identifier of the underlying report definition, if available.
`definitionName`	string \| null	Name of the underlying report definition, if available.
`templateId`	uuid	Unique identifier of the template used for the execution.
`templateName`	string	Name of the template used for the execution.
`createDateTime`	date-time	Date and time when the report run started.
`finishDateTime`	date-time	Date and time when the report run finished, if completed.
`status`	string enum	Current processing state of the report result. • PENDING • PROCESSING • COMPLETED • CANCELLED • FAILED
`recordCount`	int64 \| null	Total number of records included in this report result, if available.
`scheduleId`	uuid \| null	Unique identifier of the schedule that triggered the execution; `null` for manual runs.
`outputs`	array of objects	The outputs array contains one or more objects that describe each generated file or artifact produced by the report results run.

Outputs array objects

Object	Type	Description
fileName	string	The name of the generated report file, including its extension, as stored and returned by the reporting service.
fileSize	int64	The size of the generated report file in bytes, indicating how large the downloadable output is.
format	string enum	File format of the generated report. • CSV • HTML • PDF • RTF • XML • XLS • XLSX • TXT
compression	string \| null enum	Compression applied to the generated file content. • null - no compression • ZIP - ZIP archive • GZIP - GZIP stream
reportUrl	uri	URL for downloading the generated report file.

Example response

{
  "count": 2,
  "value": [
    {
      "reportId": "3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712",
      "reportName": "Monthly Sales Summary – January",
      "definitionId": "3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712",
      "definitionName": "Monthly Sales Summary",
      "templateId": "08a4cb0d-1b2b-4bb2-80c0-1af904205d85",
      "templateName": "Sales Summary Template",
      "createDateTime": "2026-01-05T14:22:31Z",
      "finishDateTime": "2026-01-05T14:22:59Z",
      "status": "COMPLETED",
      "recordCount": 4821,
      "scheduleId": null,
      "outputs": [
        {
          "fileName": "Monthly_Sales_Summary_Jan_2026.csv",
          "fileSize": 289314,
          "format": "CSV",
          "compression": null,
          "reportUrl": "https://platform-reporting.vertexcloud.com/downloads/3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712/a72d44be-52c0-4f9f-9e84-0f6b32c8c5dd/file.csv?signature=example"
        }
      ]
    },
    {
      "reportId": "3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712",
      "reportName": "Monthly Sales Summary – December",
      "definitionId": "3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712",
      "definitionName": "Monthly Sales Summary",
      "templateId": "08a4cb0d-1b2b-4bb2-80c0-1af904205d85",
      "templateName": "Sales Summary Template",
      "createDateTime": "2025-12-05T13:54:10Z",
      "finishDateTime": "2025-12-05T13:54:44Z",
      "status": "COMPLETED",
      "recordCount": 5012,
      "scheduleId": "9d258313-d12e-4a70-a3ce-c805fae23ac6",
      "outputs": [
        {
          "fileName": "Monthly_Sales_Summary_Dec_2025.pdf",
          "fileSize": 912884,
          "format": "PDF",
          "compression": "ZIP",
          "reportUrl": "https://platform-reporting.vertexcloud.com/downloads/3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712/bbc24c69-46c1-4c87-ae0a-7fa197d14411/file.pdf.zip?signature=example"
        }
      ]
    }
  ]
}

Get report result details by `definitionId` and `resultId`

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

Request URL:

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

Request

Both path parameters for this endpoint are required.

Parameter name	Parameter format	Parameter description
`definitionId`	uuid	Required. Unique ID of the report definition.
`reportResultId`	uuid	Required. Unique ID of the report result.

Example request

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'

Response

The following table lists the ReportResultDetails fields you receive as a response to the get report result details request.

Response field	Type	Description
`reportId`	uuid	Unique identifier for the report result.
`reportName`	string	Human‑readable name of the report run.
`definitionId`	uuid \| null	Identifier of the underlying report definition, if available.
`definitionName`	string \| null	Name of the underlying report definition, if available.
`templateId`	uuid	Unique identifier of the template used for the execution.
`templateName`	string	Name of the template used for the execution.
`createDateTime`	date-time	Date and time when the report run started.
`finishDateTime`	date-time	Date and time when the report run finished, if completed.
`status`	string enum	Current processing state of the report result. • PENDING • PROCESSING • COMPLETED • CANCELLED • FAILED
`recordCount`	int64 \| null	Total number of records included in this report result, if available
`scheduleId`	uuid \| null	Unique identifier of the schedule that triggered the execution; `null` for manual runs.
`outputs`	array of objects	The outputs array contains one or more objects that describe each generated file or artifact produced by the report results run.

Outputs array objects

Object	Type	Description
fileName	string	The name of the generated report file, including its extension, as stored and returned by the reporting service.
fileSize	int64	The size of the generated report file in bytes, indicating how large the downloadable output is.
format	string enum	File format of the generated report. • CSV • HTML • PDF • RTF • XML • XLS • XLSX • TXT
compression	string \| null enum	Compression applied to the generated file content. • null - no compression • ZIP - ZIP archive • GZIP - GZIP stream
reportUrl	uri	URL for downloading the generated report file.

Example response

{
  "reportId": "3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712",
  "reportName": "Monthly Sales Summary",
  "definitionId": "3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712",
  "definitionName": "Monthly Sales Summary",
  "templateId": "08a4cb0d-1b2b-4bb2-80c0-1af904205d85",
  "templateName": "Sales Summary Template",
  "createDateTime": "2026-01-05T14:22:31Z",
  "finishDateTime": "2026-01-05T14:22:59Z",
  "status": "COMPLETED",
  "recordCount": 4821,
  "scheduleId": null,
  "outputs": [
    {
      "fileName": "Monthly_Sales_Summary_2026-01-05.csv",
      "fileSize": 289314,
      "format": "CSV",
      "compression": null,
      "reportUrl": "https://platform-reporting.vertexcloud.com/downloads/3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712/a72d44be-52c0-4f9f-9e84-0f6b32c8c5dd/file.csv?signature=example"
    },
    {
      "fileName": "Monthly_Sales_Summary_2026-01-05.pdf",
      "fileSize": 934112,
      "format": "PDF",
      "compression": "ZIP",
      "reportUrl": "https://platform-reporting.vertexcloud.com/downloads/3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712/a72d44be-52c0-4f9f-9e84-0f6b32c8c5dd/file.pdf.zip?signature=example"
    }
  ]
}

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

Request

All query parameters for this endpoint are optional.

Parameter name	Parameter format	Parameter description
`definitionId`	uuid	Filter by a unique report definition ID.
`templateId`	uuid	Filter by a unique template ID.
`categoryId`	uuid	Filter by a unique report category ID.
`status`	string enum	Filter by status. • PENDING • PROCESSING • COMPLETED • CANCELLED • FAILED
`name`	string	Filter by report result name (case-insensitive substring match).
`createDateFrom`	date, ISO-8601	Return only report results created on or after the specified date (inclusive).
`createDateTo`	date, ISO-8601	Return only report results created on or before the specified date (inclusive).

Example request

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

Response

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

Response field	Type	Description
`count`	integer	Total number of report results for the specified definition.
`value`	array	Array of `ReportResultDetails` objects.

The following table lists the ReportResultDetails fields you receive as a response to the list report results request.

Response field	Type	Description
`reportId`	uuid	Unique identifier for the report result.
`reportName`	string	Human‑readable name of the report run.
`definitionId`	uuid \| null	Identifier of the underlying report definition, if available.
`definitionName`	string \| null	Name of the underlying report definition, if available.
`templateId`	uuid	Unique identifier of the template used for the execution.
`templateName`	string	Name of the template used for the execution.
`createDateTime`	date-time	Date and time when the report run started.
`finishDateTime`	date-time	Date and time when the report run finished, if completed.
`status`	string enum	Current processing state of the report result. • PENDING • PROCESSING • COMPLETED • CANCELLED • FAILED
`recordCount`	string	Filter by report result name (case-insensitive substring match).
`scheduleId`	uuid \| null	Unique identifier of the schedule that triggered the execution; `null` for manual runs.
`outputs`	array of objects	The outputs array contains one or more objects that describe each generated file or artifact produced by the report results run.

Outputs array objects

Object	Type	Description
fileName	string	The name of the generated report file, including its extension, as stored and returned by the reporting service.
fileSize	int64	The size of the generated report file in bytes, indicating how large the downloadable output is.
format	string enum	File format of the generated report. • CSV • HTML • PDF • RTF • XML • XLS • XLSX • TXT
compression	string \| null enum	Compression applied to the generated file content. • null - no compression • ZIP - ZIP archive • GZIP - GZIP stream
reportUrl	uri	URL for downloading the generated report file.

Example response

{
  "reportId": "3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712",
  "reportName": "Monthly Sales Summary",
  "definitionId": "3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712",
  "definitionName": "Monthly Sales Summary",
  "templateId": "08a4cb0d-1b2b-4bb2-80c0-1af904205d85",
  "templateName": "Sales Summary Template",
  "createDateTime": "2026-01-05T14:22:31Z",
  "finishDateTime": "2026-01-05T14:22:59Z",
  "status": "COMPLETED",
  "recordCount": 4821,
  "scheduleId": null,
  "outputs": [
    {
      "fileName": "Monthly_Sales_Summary_2026-01-05.csv",
      "fileSize": 289314,
      "format": "CSV",
      "compression": null,
      "reportUrl": "https://platform-reporting.vertexcloud.com/downloads/3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712/a72d44be-52c0-4f9f-9e84-0f6b32c8c5dd/file.csv?signature=example"
    },
    {
      "fileName": "Monthly_Sales_Summary_2026-01-05.pdf",
      "fileSize": 934112,
      "format": "PDF",
      "compression": "ZIP",
      "reportUrl": "https://platform-reporting.vertexcloud.com/downloads/3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712/a72d44be-52c0-4f9f-9e84-0f6b32c8c5dd/file.pdf.zip?signature=example"
    }
  ]
}

Get report result details by `resultId` only

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

Request URL:

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

Request

The resultId path parameter for this endpoint is required.

Parameter name	Parameter format	Parameter description
`resultId`	uuid	Required. Unique ID of the report result.

Example request

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

Response

The following table lists the ReportResultDetails fields you receive as a response to the get report result details request.

Response field	Type	Description
`reportId`	uuid	Unique identifier for the report result.
`reportName`	string	Human‑readable name of the report run.
`definitionId`	uuid \| null	Identifier of the underlying report definition, if available.
`definitionName`	string \| null	Name of the underlying report definition, if available.
`templateId`	uuid	Unique identifier of the template used for the execution.
`templateName`	string	Name of the template used for the execution.
`createDateTime`	date-time	Date and time when the report run started.
`finishDateTime`	date-time	Date and time when the report run finished, if completed.
`status`	string enum	Current processing state of the report result. • PENDING • PROCESSING • COMPLETED • CANCELLED • FAILED
`recordCount`	int64 \| null	Total number of records included in this report result, if available
`scheduleId`	uuid \| null	Unique identifier of the schedule that triggered the execution; `null` for manual runs.
`outputs`	array of objects	The outputs array contains one or more objects that describe each generated file or artifact produced by the report results run.

Outputs array objects

Object	Type	Description
fileName	string	The name of the generated report file, including its extension, as stored and returned by the reporting service.
fileSize	int64	The size of the generated report file in bytes, indicating how large the downloadable output is.
format	string enum	File format of the generated report. • CSV • HTML • PDF • RTF • XML • XLS • XLSX • TXT
compression	string \| null enum	Compression applied to the generated file content. • null - no compression • ZIP - ZIP archive • GZIP - GZIP stream
reportUrl	uri	URL for downloading the generated report file.

Example response

{
  "reportId": "a72d44be-52c0-4f9f-9e84-0f6b32c8c5dd",
  "reportName": "Monthly Sales Summary – January",
  "definitionId": "3c9f1e62-8b47-4d3d-bf3a-91c4d2fba712",
  "definitionName": "Monthly Sales Summary",
  "templateId": "08a4cb0d-1b2b-4bb2-80c0-1af904205d85",
  "templateName": "Sales Summary Template",
  "createDateTime": "2026-01-05T14:22:31Z",
  "finishDateTime": "2026-01-05T14:22:59Z",
  "status": "COMPLETED",
  "recordCount": 4821,
  "scheduleId": null,
  "outputs": [
    {
      "fileName": "Monthly_Sales_Summary_2026-01-05.csv",
      "fileSize": 289314,
      "format": "CSV",
      "compression": null,
      "reportUrl": "https://platform-reporting.vertexcloud.com/downloads/a72d44be-52c0-4f9f-9e84-0f6b32c8c5dd/output.csv?signature=example"
    },
    {
      "fileName": "Monthly_Sales_Summary_2026-01-05.pdf",
      "fileSize": 934112,
      "format": "PDF",
      "compression": "ZIP",
      "reportUrl": "https://platform-reporting.vertexcloud.com/downloads/a72d44be-52c0-4f9f-9e84-0f6b32c8c5dd/output.pdf.zip?signature=example"
    }
  ]
}

List report results for a report definition

Request

Example request

Response

Outputs array objects

Example response

Get report result details by definitionId and resultId

Request

Example request

Response

Outputs array objects

Example response

List report results

Request

Example request

Response

Outputs array objects

Example response

Get report result details by resultId only

Request

Example request

Response

Outputs array objects

Example response

Get report result details by `definitionId` and `resultId`

Get report result details by `resultId` only