Use the Solution Reporting API to retrieve report definitions and access detailed metadata that describes each available report, including its template, category, and creation attributes. The Reports endpoints let developers list all report definitions or fetch a specific one by ID. This enables precise discovery of reporting assets and provides the foundational information needed to run reports, retrieve results, or build automated reporting workflows.

Base URL:

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

Reports endpoint	Endpoint description
`/reports`	GET - Retrieve a list of report definitions, optionally filtered by template, category, name, and creation date.
`/reports/{reportId}`	GET - Retrieve full metadata for a single report definition.
`/reports/{reportId}/results`	POST - Execute a report definition and create a new report result. The report is executed asynchronously, and the generated report result metadata is returned.

List report definitions

Retrieve a list of report definitions, optionally filtered by template, category, name, and creation date.

Request URL:

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

Request

All request parameters are optional. Passing a request with no parameters returns all available records.

Parameter name	Parameter format	Parameter description
`templateId`	uuid	Filter by template UUID.
`categoryId`	uuid	Filter by report category UUID.
`name`	string	Filter by report definition name (case-insensitive substring match).
`createDateFrom`	date, ISO-8601	ISO-8601 creation start date (inclusive).
`createDateTo`	date, ISO-8601	ISO-8601 creation end date (inclusive).

Example request

curl --request GET \
     --url 'https://platform-reporting.vertexcloud.com/api/v1/reports?templateId=3f72d6c5-f671-4d28-8f43-b0bb4c26e50d' \
     --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 matching report definitions.
`value`	array	Array of `ReportDefinitionDetails` objects.

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

Response field	Type	Description
`id`	string (UUID)	Unique identifier for the report definition.
`name`	string	Human‑readable report definition name.
`description`	string	Optional description of the report.
`templateId`	string (UUID)	ID of the template the report is based on.
`templateName`	string	Name of the associated template.
`category`	object	Contains: • id (UUID) • name (string)
`createdDateTime`	string (ISO-8601 datetime)	When the report definition was created.
`modifiedDateTime`	string (ISO-8601 datetime)	When the report definition was last updated.
`fields`	array or null	Field selections for the report definition.
`filters`	array or null	Filter definitions applied to the report.

Example response

{
  "id": "8c3a3fa4-6c59-4ef9-8a9d-4c0a99f0e921",
  "name": "Monthly Sales Summary",
  "description": "Summary of monthly sales totals by region.",
  "templateId": "3f72d6c5-f671-4d28-8f43-b0bb4c26e50d",
  "templateName": "Sales Summary Template",
  "category": {
    "id": "b2fb1b52-bf71-4a67-ad3b-7b6336872e62",
    "name": "Sales Reports"
  },
  "createdDateTime": "2025-10-18T14:32:10Z",
  "modifiedDateTime": "2025-12-01T09:12:45Z",
  "fields": [
    {
      "name": "Region",
      "displayName": "Region",
      "type": "string"
    },
    {
      "name": "TotalSales",
      "displayName": "Total Sales",
      "type": "decimal"
    }
  ],
  "filters": [
    {
      "field": "TransactionDate",
      "operator": "GreaterThanOrEqual",
      "value": "2025-10-01"
    }
  ]
}

Get report definition

Retrieve full metadata for a single report definition.

Request URL:

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

Request

Only the reportId parameter is required as a path parameter.

Parameter name	Parameter format	Parameter description
`reportId`	uuid	Include the unique identifier as a path parameter.

Example request


curl --request GET \
  --url "https://platform-reporting.vertexcloud.com/api/v1/reports/8c3a3fa4-6c59-4ef9-8a9d-4c0a99f0e921" \
  --header "Accept: application/json" \

Response

A response includes the ReportDefinitionDetails fields.

Response field	Type	Description
`id`	string (UUID)	Unique identifier for the report definition.
`name`	string	Human‑readable report definition name.
`description`	string	Optional description of the report.
`templateId`	string (UUID)	ID of the template the report is based on.
`templateName`	string	Name of the associated template.
`category`	object	Contains: • id (UUID) • name (string)
`createdDateTime`	string (ISO-8601 datetime)	When the report definition was created.
`modifiedDateTime`	string (ISO-8601 datetime)	When the report definition was last updated.
`fields`	array or null	Field selections for the report definition.
`filters`	array or null	Filter definitions applied to the report.

Example response

{
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "string",
  "name": "string",
  "startDate": "2025-09-15",
  "endDate": "2025-09-15",
  "status": "Approved",
  "approvalDate": "2025-09-15",
  "isParentInd": true,
  "customFields": [
    {
      "id": 0,
      "label": "string",
      "value": "string"
    }
  ],
  "parent": {
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "code": "string",
    "name": "string"
  },
  "taxpayer": {
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "code": "string",
    "name": "string"
  }
}

Run report definition

Execute a report definition and create a new report result. The report is executed asynchronously, and the generated report result metadata is returned so you can poll or list the results later.

Request URL:

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

Request

Only the reportId parameter is required as a path parameter.

Parameter name	Parameter format	Parameter description
`reportId`	uuid	Include the unique identifier as a path parameter.

Example request


curl --request GET \
  --url "https://platform-reporting.vertexcloud.com/api/v1/reports/8c3a3fa4-6c59-4ef9-8a9d-4c0a99f0e921/results" \
  --header "Accept: application/json" \

Response

A successful response consists of metadata describing the newly created report result.

Field	Type	Description
`reportid`	uuid	Unique identifier of 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 report execution.
templateName	string	Name of the template used for the report execution.
createDateTime	date-time	Date and time when the report run started.
finishDateTime	date-time \| null	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 report execution. The value is `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 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.