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, create a new saved report definition, 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	Reports endpoint description
`/reports`	GET - Retrieve a list of report definitions, optionally filtered by template, category, name, and creation date.
`/reports`	POST - Create a new saved report definition based on an existing template. Use a `DATA_EXTRACT` to requests provide filters and field configurations, while `STANDARD_REPORT` requests provide parameter values.
`/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 saved report definitions, optionally filtered by template, template type, category, name, lifecycle status, and creation date.

Request URL:

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

List report definitions request

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

List report definitions parameter name	List report definitions parameter format	List report definitions parameter description
`templateId`	array of uuids	Filter by template UUID (supports multiple values: (`?templateId=id1&templateId=id2`).
`templateType`	string enum	Filter by template type. Allowed: `STANDARD_REPORT`, `DATA_EXTRACT`.
`templateName`	string	Filter by template name (case-insensitive substring match).
`categoryId`	array of uuids	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).
`status`	string enum	Filter by report definition lifecycle status. Allowed: `ACTIVE`, `ARCHIVED`, `ALL`. Defaults to `ACTIVE`.
`offset`	integer	Number of items to skip (for pagination). Must be greater than or equal to 0. Defaults to 0.
`limit`	integer	Maximum number of items to return. Must be between 1 to 500. Defaults to 25.
`sortBy`	string enum	Field to sort by. Allowed: `NAME`, `TEMPLATE_NAME`, `CATEGORY_NAME`, `CREATED_AT`, `FINISH_DATE_TIME`, `STATUS`. Defaults to `CREATED_AT`.
`sortOrder`	string enum	Sort direction. Allowed: `ASC` or `DESC`. Defaults to `ASC`.

List report definitions example request

curl --request GET \
     --url 'https://platform-reporting.vertexcloud.com/api/v1/reports?templateId=3f72d6c5-f671-4d28-8f43-b0bb4c26e50d' \
     --header 'accept: application/json'

List report definitions response

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

List report definitions response field	List report definitions type	List report definitions description
`count`	integer	Total number of matching report definitions.
`offset`	integer	Number of items skipped. Must be greater than or equal to 0.
`limit`	integer	Maximum items per page. Must be greater than or equal to 1.
`value`	array	Array of `ReportDefinitionSummary` objects.

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

List report definitions response field	List report definitions type	List report definitions description
`id`	uuid	Unique identifier for the report definition.
`name`	string	Human‑readable report definition name.
`description`	string	Optional description of the report.
`templateId`	uuid	ID of the template the report is based on.
`templateName`	string	Name of the associated template.
`templateDisplayName`	string	Display name of the template that this report definition is based on.
`templateType`	string enum	Template classification. Allowed: `STANDARD_REPORT`, `DATA_EXTRACT`.
`category`	object \| null	Report category. Contains: `id` (UUID) and `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.
`status`	string enum	Lifecycle status of the report definition. Allowed: `ACTIVE`, `ARCHIVED`.

List report definitions response example

{
  "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"
    }
  ]
}

Create report definition

Create a new saved report definition based on an existing template. The DATA_EXTRACT requests provide filters and field configurations, while the STANDARD_REPORT requests provide parameter values.

Request URL:

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

Create report definition request

Either DATA_EXTRACT or STANDARD_REPORT are required as a body parameter indicator.

Create a DATA_EXTRACT report definition request

Parameter name	Parameter format	Parameter description
`templateType` Required	string enum	Discriminator indicating this is a `DATA_EXTRACT` report request.
`name` Required	string	Name of the report definition. Length must be 1 to 60 characters.
`description`	string \| null	Optional description of the report definition.
`templateId` Required	uuid	UUID of the template used to create the report definition.
`filters`	array of objects	Filters applied when the report definition is executed. Length must be greater than or equal to 0.
`filterLogic`	string \| null	Custom filter combination logic such as `1 AND (2 OR 3)`. When null, filters are combined with `AND`.
`fields` Required	array of objects	Selected fields for the report. Each field name must match a field available in the associated template. Length must be greater than or equal to 1.
`format`	string enum	File format of the generated report. Allowed: `CSV`, `HTML`, `PDF`, `RTF`, `XML`, `XLS`, `XLSX`, `TXT`.
`settings`	object \| null	Display and render settings for `DATA_EXTRACT` reports. Which settings are applicable depends on the chosen output format.

Create DATA_EXTRACT report definition request Filters array objects

Filter definition applied in a DATA_EXTRACT report definition.

Parameter name	Parameter format	Parameter description
`targetKey` Required	string	Identifier of the filter target `FIELD`. Length must be equal to or greater than 1.
`displayName`	string \| null	Human-readable label of the filter target, if available.
`filterOperator`	string enum	Operator used to apply the filter (to compare the filter value with the field value). Allowed: `EQUALS`, `NOT_EQUALS`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`, `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `IN`, `NOT_IN`, `CONTAINS`, `NOT_CONTAINS`, `STARTS_WITH`, `NOT_STARTS_WITH`, `ENDS_WITH`, `NOT_ENDS_WITH`, `IS_NULL`, `IS_NOT_NULL`, `IN_TIME_PERIOD`, `EQUALS_MIN_VALUE`, `EQUALS_MAX_VALUE`.
`value`	string	Filter value encoded as string for single-value operators.
`values`	array of strings \| null	Values for multi-value operators such as `IN` or `NOT_IN`.

Create DATA_EXTRACT report definition request Fields array objects

Writable field configuration for a custom DATA_EXTRACT template. The field name must reference a field from the base template.

Parameter name	Parameter format	Parameter description
`name` Required	string	Field name (must match a field from the base template). Length must be equal to or greater than 1.
`position` Required	int32	Display position of the field.
`sortOrder` Required	string enum	Sort order applied to a field. Allowed: `NONE`, `ASCENDING`, `DESCENDING`.
`function` Required	string enum	Aggregation or grouping function applied to a field. Allowed: `NONE`, `SUM`, `AVERAGE`, `COUNT`, `COUNT_DISTINCT`, `GROUP`, `MAX`, `MIN`.
`visualGroupIndicator` Required	boolean \| null	Whether this field is used as a visual group indicator.
`alignment`	string enum	Text alignment for a field. Allowed: `LEFT`, `RIGHT`, `CENTER`.
`width`	int 32 \| null	Column width hint. Unit is renderer-specific. Must be an integer between 0 to 99999999.
`wrapIndicator` Required	boolean \| null	Whether to wrap text in this column.
`columnLabel`	string \| null	Custom display name for the column header.

Create a DATA_EXTRACT report definition request Settings object

Parameter name	Parameter format	Parameter description
`showColumnHeaders`	boolean	Show column headers in the report output (XLS, XLSX, HTML, PDF, RTF).
`showRecordCount`	boolean	Show total record count (HTML, PDF, RTF).
`showTotals`	boolean	Show totals row (HTML, PDF, RTF).
`showRowNumbers`	boolean	Show row numbers (HTML, PDF, RTF).
`showDataSource`	boolean	Show data source information (HTML, PDF, RTF)
`showFilters`	boolean	Show applied filters in the output (HTML, PDF, RTF).
`showUniqueRows`	boolean	Show only unique rows (all formats).
`pageOrientation`	string enum	Page orientation (PDF, RTF). Allowed: `PORTRAIT`, `LANDSCAPE`.
`textQualifier`	string \| null	Character used to qualify text fields, such as double-quote (CSV).
`fieldDelimiter`	string \| null	Character used to delimit fields, such as comma, tab (CSV).
`recordLimit`	integer \| null ≥ 1	Maximum number of records in the report output, `null` means unlimited.
`zipReport`	boolean	Whether to compress the report output as a ZIP archive.

Create a DATA_EXTRACT report definition request example

curl --request POST \
     --url https://platform-reporting.vertexcloud.com/api/v1/reports \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "templateType": "DATA_EXTRACT",
  "fields": [
    {
      "sortOrder": "NONE",
      "function": "NONE",
      "visualGroupIndicator": true,
      "wrapIndicator": true
    }
  ],
  "format": "CSV"
}
'

Create a DATA_EXTRACT report definition response

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 definition (read-only).
`templateId`	string (uuid)	Identifier of the template used by this report definition.
`templateName`	string	Name of template that this report definition is based on.
`templateDisplayName`	string	Display name of the template that this report definition is based on.
`templateType`	string	Template classification, in this case `DATA_EXTRACT`.
`category`	object	Report category. Contains: `id` (uuid) and `name` (string).
`createdDateTime`	string (ISO-8601 datetime)	Creation timestamp of the report definition.
`modifiedDateTime`	string (ISO-8601 datetime)	Last modification timestamp of the report definition.
`status`	string	Lifecycle status of the report definition. Either `ACTIVE` or `ARCHIVED`.
`fields`	array of objects	Selected `DATA_EXTRACT` fields for this report definition. Each field name must match a field available in the associated template.
`filters`	array of objects	Filter definitions applied when this report definition is executed.
`filterLogic`	string \| null	Custom filter combination logic such as `1 AND (2 OR 3)`. When null, filters are combined with `AND`.
`format`	string enum	File format of the generated report. Allowed: `CSV`, `HTML`, `PDF`, `RTF`, `XML`, `XLS`, `XLSX`, `TXT`.
`settings`	object \| null	Display and render settings for `DATA_EXTRACT` reports. Which settings are applicable depends on the chosen output format.

Create DATA_EXTRACT report definition response Fields array of objects

Writable field configuration for a custom ReportDefinitionField template. The field name must reference a field from the base template.

Field name	Type	Description
`name`	string	Field name (must match a field from the base template). Length must be equal to or greater than 1.
`dataType`	string \| enum	Logical data type of a field or parameter, represented as a discriminated union: `SIMPLE` for basic primitive types, `PATTERNED` for dates and timestamps with a format, and `ARRAY` for arrays of another data type. The `ARRAY` object can include nested objects.
`position`	int32 \| null	Position of the field within the report.
`sortOrder`	string enum	Sort order applied to a field. Allowed: `NONE`, `ASCENDING`, `DESCENDING`.
`function`	string enum	Aggregation or grouping function applied to a field. Allowed: `NONE`, `SUM`, `AVERAGE`, `COUNT`, `COUNT_DISTINCT`, `GROUP`, `MAX`, `MIN`.
`visualGroupIndicator`	boolean \| null	Indicates whether this field is used as a visual group or break.
`format`	string enum	Display format for a field value. Allowed: `USA_DATE`, `USA_DATE_TIME`, `SHORT_DATE`, `MEDIUM_DATE`, `LONG_DATE`, `UNIVERSAL_DATE`, `CURRENCY`, `YES_NO`, `NUMBER`.
`alignment`	string enum	Text alignment for a field. Allowed: `LEFT`, `RIGHT`, `CENTER`.
`width`	int 32 \| null	Column width hint. Unit is renderer-specific. Must be an integer between 0 to 99999999.
`wrapIndicator`	boolean \| null	Whether to wrap text in this column.

Create a DATA_EXTRACT report definition response Fields SIMPLEDATATYPE object

Simple base type without additional metadata.

Field name	Type	Description
`type`	string enum	Discriminator for a simple data type. Must be `SIMPLE`.
`baseType`	string enum	Base simple type. Allowed: `TEXT`, `NUMBER`, `BOOLEAN`, `DECIMAL`, `CURRENCY`.

Create a DATA_EXTRACT report definition response Fields PATTERNEDDATATYPE object

Date or timestamp type with a format pattern.

Field name	Type	Description
`type`	string enum	Discriminator for a patterned data type. Must be `PATTERNED`.
`baseType`	string enum	Base simple type. Allowed: `DATE`, `TIMESTAMP`.
`pattern`	string	Format pattern for the value, for example `yyyy-MM-dd` or `yyyyMMdd`.

Create a DATA_EXTRACT report definition response Fields ARRAYDATATYPE object

Array of another data type.

Field name	Type	Description
`type`	string enum	Discriminator for an array data type. Must be `ARRAY`.
`elementType`	object	Logical data type of a field or parameter, represented as a discriminated union: `SIMPLE` for basic primitive types, `PATTERNED` for dates and timestamps with a format, and `ARRAY` for arrays of another data type. The `ARRAY` object can include nested objects.

Create DATA_EXTRACT report definition response Filters array of objects

A response includes the ReportDefinitionFilter object.

Field name	Type	Description
`targetKey`	string	Identifier of the filter target `FIELD`. Length must be equal to or greater than 1.
`displayName`	string \| null	Human-readable label of the filter target, if available.
`dataType`	object	Data type of the filter value. Allowed: `ArrayDataType`, `PatternedDataType`, `SimpleDataType`.
`filterOperator`	string enum	Operator used to apply the filter (to compare the filter value with the field value). Allowed: `EQUALS`, `NOT_EQUALS`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`, `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `IN`, `NOT_IN`, `CONTAINS`, `NOT_CONTAINS`, `STARTS_WITH`, `NOT_STARTS_WITH`, `ENDS_WITH`, `NOT_ENDS_WITH`, `IS_NULL`, `IS_NOT_NULL`, `IN_TIME_PERIOD`, `EQUALS_MIN_VALUE`, `EQUALS_MAX_VALUE`.
`value`	string	Filter value encoded as string for single-value operators.
`values`	array of strings \| null	Values for multi-value operators such as `IN` or `NOT_IN`.

Create a DATA_EXTRACT report definition response Filters SIMPLEDATATYPE object

Simple base type without additional metadata.

Field name	Type	Description
`type`	string enum	Discriminator for a simple data type. Must be `SIMPLE`.
`baseType`	string enum	Base simple type. Allowed: `TEXT`, `NUMBER`, `BOOLEAN`, `DECIMAL`, `CURRENCY`.

Create a DATA_EXTRACT report definition response Filters PATTERNEDDATATYPE object

Date or timestamp type with a format pattern.

Field name	Type	Description
`type`	string enum	Discriminator for a patterned data type. Must be `PATTERNED`.
`baseType`	string enum	Base simple type. Allowed: `DATE`, `TIMESTAMP`.
`pattern`	string	Format pattern for the value, for example `yyyy-MM-dd` or `yyyyMMdd`.

Create a DATA_EXTRACT report definition response Filters ARRAYDATATYPE object

Array of another data type.

Field name	Type	Description
`type`	string enum	Discriminator for an array data type. Must be `ARRAY`.
`elementType`	object	Logical data type of a field or parameter, represented as a discriminated union: `SIMPLE` for basic primitive types, `PATTERNED` for dates and timestamps with a format, and `ARRAY` for arrays of another data type. The `ARRAY` object can include nested objects.

Create a DATA_EXTRACT report definition response Settings object

Field name	Type	Description
`showColumnHeaders`	boolean	Show column headers in the report output (XLS, XLSX, HTML, PDF, RTF).
`showRecordCount`	boolean	Show total record count (HTML, PDF, RTF).
`showTotals`	boolean	Show totals row (HTML, PDF, RTF).
`showRowNumbers`	boolean	Show row numbers (HTML, PDF, RTF).
`showDataSource`	boolean	Show data source information (HTML, PDF, RTF)
`showFilters`	boolean	Show applied filters in the output (HTML, PDF, RTF).
`showUniqueRows`	boolean	Show only unique rows (all formats).
`pageOrientation`	string enum	Page orientation (PDF, RTF). Allowed: `PORTRAIT`, `LANDSCAPE`.
`textQualifier`	string \| null	Character used to qualify text fields, such as double-quote (CSV).
`fieldDelimiter`	string \| null	Character used to delimit fields, such as comma, tab (CSV).
`recordLimit`	integer \| null	Maximum number of records in the report output, `null` means unlimited. Must be greater than or equal to 1.
`zipReport`	boolean	Whether to compress the report output as a ZIP archive.

Create a DATA_EXTRACT report definition response example

{
  "templateType": "DATA_EXTRACT",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "My Tax Extract Report",
  "description": null,
  "templateId": "8f14e45f-ceea-367f-a027-7e3c0a9d5d4e",
  "templateName": "tax_extract_template",
  "templateDisplayName": "Tax Extract Template",
  "category": {
    "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "name": "Tax Reports"
  },
  "createdDateTime": "2024-01-15T10:30:00Z",
  "modifiedDateTime": "2024-01-15T10:30:00Z",
  "status": "ACTIVE",
  "fields": [
    {
      "name": "INVOICE_DATE",
      "dataType": {
        "type": "PATTERNED",
        "baseType": "DATE",
        "pattern": "yyyy-MM-dd"
      },
      "position": 1,
      "sortOrder": "NONE",
      "function": "NONE",
      "visualGroupIndicator": false,
      "wrapIndicator": false
    }
  ],
  "filters": [],
  "filterLogic": null,
  "format": "CSV",
  "settings": null
}

Create a STANDARD_REPORT report definition request

Parameter name	Parameter format	Parameter description
`templateType` Required	string enum	Discriminator indicating this is a `STANDARD_REPORT` report request.
`name` Required	string	Name of the report definition. Length must be 1 to 30 characters.
`description`	string \| null	Optional description of the report definition.
`templateId` Required	uuid	UUID of the template used to create the report definition.
`parameters`	array of objects	Filters applied when the report definition is executed. Length must be greater than or equal to 0.
`format`	string enum	File format of the generated report. Allowed: `CSV`, `HTML`, `PDF`, `RTF`, `XML`, `XLS`, `XLSX`, `TXT`.

Create STANDARD_REPORT report definition Parameters array objects

Value assigned to a STANDARD_REPORT parameter.

Parameter name	Parameter format	Parameter description
`parameterId` Required	string	Identifier of the template parameter.
`value`	string	Filter value encoded as string for single-value operators.
`values`	array of strings \| null	Values for multi-value operators such as `IN` or `NOT_IN`.

Create a STANDARD_REPORT report definition request example

curl --request POST \
     --url https://platform-reporting.vertexcloud.com/api/v1/reports \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "templateType": "STANDARD_REPORT",
  "format": "CSV",
  "parameters": [
    {
      "values": []
    }
  ]
}
'

Create a STANDARD_REPORT report definition response

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 definition (read-only).
`templateId`	string (uuid)	Identifier of the template used by this report definition.
`templateName`	string	Name of template that this report definition is based on.
`templateDisplayName`	string	Display name of the template that this report definition is based on.
`templateType`	string enum	Template classification. In this case `STANDARD_REPORT`.
`category`	object	Report category. Contains: `id` (uuid), `name` (string).
`createdDateTime`	string (ISO-8601 datetime)	Creation timestamp of the report definition.
`modifiedDateTime`	string (ISO-8601 datetime)	Last modification timestamp of the report definition.
`status`	string enum	Lifecycle status of the report definition. Allowed: `ACTIVE` or `ARCHIVED`.
`parameters`	array of objects	Parameter values applied when this report definition is executed.
`format`	string enum	File format of the generated report. Allowed: `CSV`, `HTML`, `PDF`, `RTF`, `XML`, `XLS`, `XLSX`, `TXT`.

Create a STANDARD_REPORT report definition response ReportDefinitionParameter object

Field name	Type	Description
`parameterId`	string	Identifier of the template parameter.
`displayName`	string \| null	Human-readable parameter label, if available.
`dataType`	string enum	Logical data type of a field or parameter, represented as a discriminated union: `SIMPLE` for basic primitive types, `PATTERNED` for dates and timestamps with a format, and `ARRAY` for arrays of another data type.
`value`	string	Value encoded as string for single-value parameters.
`values`	array of strings \| null	Values for multi-value parameters.

Create a STANDARD_REPORT report definition response Filters ReportDefinitionParameter SIMPLEDATATYPE object

Simple base type without additional metadata.

Field name	Type	Description
`type`	string enum	Discriminator for a simple data type. Must be `SIMPLE`.
`baseType`	string enum	Base simple type. Allowed: `TEXT`, `NUMBER`, `BOOLEAN`, `DECIMAL`, `CURRENCY`.

Create a STANDARD_REPORT report definition response ReportDefinitionParameter PATTERNEDDATATYPE object

Date or timestamp type with a format pattern.

Field name	Type	Description
`type`	string enum	Discriminator for a patterned data type. Must be `PATTERNED`.
`baseType`	string enum	Base simple type. Allowed: `DATE`, `TIMESTAMP`.
`pattern`	string	Format pattern for the value, for example `yyyy-MM-dd` or `yyyyMMdd`.

Create a STANDARD_REPORT report definition response ReportDefinitionParameter ARRAYDATATYPE object

Array of another data type.

Field name	Type	Description
`type`	string enum	Discriminator for an array data type. Must be `ARRAY`.
`elementType`	object	Logical data type of a field or parameter, represented as a discriminated union: `SIMPLE` for basic primitive types, `PATTERNED` for dates and timestamps with a format, and `ARRAY` for arrays of another data type. The `ARRAY` object can include nested objects.

Create a STANDARD_REPORT definition response example

{
  "templateType": "STANDARD_REPORT",
  "id": "7e3c0a9d-5d4e-4562-b3fc-2c963f66afa6",
  "name": "My Sales Tax Report",
  "description": null,
  "templateId": "4b2d9b5d-ab8d-4b2d-9b5d-ab8dfbbd4bed",
  "templateName": "sales_tax_template",
  "templateDisplayName": "Sales Tax Report Template",
  "category": {
    "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "name": "Tax Reports"
  },
  "createdDateTime": "2024-01-15T10:30:00Z",
  "modifiedDateTime": "2024-01-15T10:30:00Z",
  "status": "ACTIVE",
  "parameters": [
    {
      "parameterId": "PERIOD",
      "displayName": "Period",
      "dataType": {
        "type": "PATTERNED",
        "baseType": "DATE",
        "pattern": "yyyy-MM"
      },
      "value": "2024-01",
      "values": null
    }
  ],
  "format": "PDF"
}

Get report definition

Retrieve full metadata for a single report definition. The DATA_EXTRACT details include inherited read-only fields and filters. The STANDARD_REPORT details include parameter values.

Request URL:

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

Get report definition request

Only the reportId parameter is required as a path parameter.

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

Get report definition request example

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

Get report definition response

A response includes the ReportDefinitionSummary fields. Response fields are different for DATA_EXTRACT and STANDARD_REPORT responses

Get a DATA_EXTRACT report definition response

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 definition (read-only).
`templateId`	string (UUID)	Identifier of the template used by this report definition.
`templateName`	string	Name of template that this report definition is based on.
`templateDisplayName`	string	Display name of the template that this report definition is based on.
`templateType`	string	Type of report request, in this case `DATA_EXTRACT`.
`category`	object	Report category. Contains: `id` (UUID), `name` (string).
`createdDateTime`	string (ISO-8601 datetime)	Creation timestamp of the report definition.
`modifiedDateTime`	string (ISO-8601 datetime)	Last modification timestamp of the report definition.
`status`	string	Lifecycle status of the report definition. Either `ACTIVE` or `ARCHIVED`.
`fields`	array of objects	Selected `DATA_EXTRACT` fields for this report definition. Each field name must match a field available in the associated template.
`filters`	array of objects	Filter definitions applied when this report definition is executed.
`filterLogic`	string \| null	Custom filter combination logic such as `1 AND (2 OR 3)`. When null, filters are combined with `AND`.
`format`	string enum	File format of the generated report. Allowed: `CSV`, `HTML`, `PDF`, `RTF`, `XML`, `XLS`, `XLSX`, `TXT`.
`settings`	object \| null	Display and render settings for `DATA_EXTRACT` reports. Which settings are applicable depends on the chosen output format.

Get a DATA_EXTRACT report definition response Fields array of objects

A response includes the ReportDefinitionField object.

Field name	Type	Description
`name` Required	string	Field name (must match a field from the base template). Length must be equal to or greater than 1.
`dataType`		Logical data type of a field or parameter, represented as a discriminated union: `SIMPLE` for basic primitive types, `PATTERNED` for dates and timestamps with a format, and `ARRAY` for arrays of another data type.
`position` Required	int32 \| null	Position of the field within the report.
`sortOrder` Required	string enum	Sort order applied to a field. Allowed: `NONE`, `ASCENDING`, `DESCENDING`.
`function` Required	string enum	Aggregation or grouping function applied to a field. Allowed: `NONE`, `SUM`, `AVERAGE`, `COUNT`, `COUNT_DISTINCT`, `GROUP`, `MAX`, `MIN`.
`visualGroupIndicator` Required	boolean \| null	Indicates whether this field is used as a visual group or break.
`format`	string enum	Display format for a field value. Allowed: `USA_DATE`, `USA_DATE_TIME`, `SHORT_DATE`, `MEDIUM_DATE`, `LONG_DATE`, `UNIVERSAL_DATE`, `CURRENCY`, `YES_NO`, `NUMBER`.
`alignment`	string enum	Text alignment for a field. Allowed: `LEFT`, `RIGHT`, `CENTER`.
`width`	int 32 \| null	Column width hint. Unit is renderer-specific. Must be an integer between 0 to 99999999.
`wrapIndicator` Required	boolean \| null	Whether to wrap text in this column.

Get a DATA_EXTRACT response SIMPLEDATATYPE object

Simple base type without additional metadata.

Field name	Type	Description
`type` Required	string enum	Discriminator for a simple data type. Must be `SIMPLE`.
`baseType` Required	string enum	Base simple type. Allowed: `TEXT`, `NUMBER`, `BOOLEAN`, `DECIMAL`, `CURRENCY`.

Get a DATA_EXTRACT response PATTERNEDDATATYPE object

Date or timestamp type with a format pattern.

Field name	Type	Description
`type` Required	string enum	Discriminator for a patterned data type. Must be `PATTERNED`.
`baseType` Required	string enum	Base simple type. Allowed: `DATE`, `TIMESTAMP`.
`pattern` Required	string	Format pattern for the value, for example `yyyy-MM-dd` or `yyyyMMdd`.

Get a DATA_EXTRACT response ARRAYDATATYPE object

Array of another data type.

Field name	Type	Description
`type` Required	string enum	Discriminator for an array data type. Must be `ARRAY`.
`elementType`	string enum	Logical data type of a field or parameter, represented as a discriminated union: `SIMPLE` for basic primitive types, `PATTERNED` for dates and timestamps with a format, and `ARRAY` for arrays of another data type.

Get a DATA_EXTRACT response Filters array of objects

A response includes the ReportDefinitionFilter object.

Field name	Type	Description
`targetKey` Required	string	Identifier of the filter target `FIELD`.
`displayName`	string \| null	Human-readable label of the filter target, if available.
`dataType`	string enum	Data type of the filter value. Allowed: `ArrayDataType`, `PatternedDataType`, `SimpleDataType`.
`filterOperator`	string enum	Operator used to apply the filter (to compare the filter value with the field value). Allowed: `EQUALS`, `NOT_EQUALS`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`, `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `IN`, `NOT_IN`, `CONTAINS`, `NOT_CONTAINS`, `STARTS_WITH`, `NOT_STARTS_WITH`, `ENDS_WITH`, `NOT_ENDS_WITH`, `IS_NULL`, `IS_NOT_NULL`, `IN_TIME_PERIOD`, `EQUALS_MIN_VALUE`, `EQUALS_MAX_VALUE`.
`value`	string	Filter value encoded as string for single-value operators.
`values`	array of strings \| null	Values for multi-value operators such as `IN` or `NOT_IN`.

Get a DATA_EXTRACT response Settings object

Field name	Type	Description
`showColumnHeaders`	boolean	Show column headers in the report output (XLS, XLSX, HTML, PDF, RTF).
`showRecordCount`	boolean	Show total record count (HTML, PDF, RTF).
`showTotals`	boolean	Show totals row (HTML, PDF, RTF).
`showRowNumbers`	boolean	Show row numbers (HTML, PDF, RTF).
`showDataSource`	boolean	Show data source information (HTML, PDF, RTF)
`showFilters`	boolean	Show applied filters in the output (HTML, PDF, RTF).
`showUniqueRows`	boolean	Show only unique rows (all formats).
`pageOrientation`	string enum	Page orientation (PDF, RTF). Allowed: `PORTRAIT`, `LANDSCAPE`.
`textQualifier`	string \| null	Character used to qualify text fields, such as double-quote (CSV).
`fieldDelimiter`	string \| null	Character used to delimit fields, such as comma, tab (CSV).
`recordLimit`	integer \| null ≥ 1	Maximum number of records in the report output, `null` means unlimited.
`zipReport`	boolean	Whether to compress the report output as a ZIP archive.

Get a DATA_EXTRACT report definition response example

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string",
  "templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "templateName": "string",
  "templateDisplayName": "string",
  "templateType": "DATA_EXTRACT",
  "category": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "createdDateTime": "2026-06-11T03:01:02.893Z",
  "modifiedDateTime": "2026-06-11T03:01:02.893Z",
  "status": "ACTIVE",
  "parameters": [
    {
      "parameterId": "string",
      "displayName": "string",
      "dataType": {
        "type": "SIMPLE",
        "baseType": "TEXT"
      },
      "value": "string",
      "values": [
        "string"
      ]
    }
  ],
  "format": "CSV"
}

Get a STANDARD_REPORT report definition response

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 definition (read-only).
`templateId`	string (UUID)	Identifier of the template used by this report definition.
`templateName`	string	Name of template that this report definition is based on.
`templateDisplayName`	string	Display name of the template that this report definition is based on.
`templateType`	string enum	Template classification. In this case `STANDARD_REPORT`.
`category`	object	Report category. Contains: `id` (UUID), `name` (string).
`createdDateTime`	string (ISO-8601 datetime)	Creation timestamp of the report definition.
`modifiedDateTime`	string (ISO-8601 datetime)	Last modification timestamp of the report definition.
`status`	string enum	Lifecycle status of the report definition. Allowed: `ACTIVE` or `ARCHIVED`.
`parameters`	array of objects	Parameter values applied when this report definition is executed.
`format`	string enum	File format of the generated report. Allowed: `CSV`, `HTML`, `PDF`, `RTF`, `XML`, `XLS`, `XLSX`, `TXT`.

Get a STANDARD_REPORT report definition response ReportDefinitionFilter object

Field name	Type	Description
`parameterId`	string	Identifier of the template parameter.
`displayName`	string \| null	Human-readable parameter label, if available.
`dataType`	string enum	Logical data type of a field or parameter, represented as a discriminated union: `SIMPLE` for basic primitive types, `PATTERNED` for dates and timestamps with a format, and `ARRAY` for arrays of another data type.
`value`	string	Value encoded as string for single-value parameters.
`values`	array of strings \| null	Values for multi-value parameters.

Get a STANDARD_REPORT report definition response SIMPLEDATATYPE object

Simple base type without additional metadata.

Field name	Type	Description
`type`	string enum	Discriminator for a simple data type. Must be `SIMPLE`.
`baseType`	string enum	Base simple type. Allowed: `TEXT`, `NUMBER`, `BOOLEAN`, `DECIMAL`, `CURRENCY`.

Get a STANDARD_REPORT report definition response PATTERNEDDATATYPE object

Date or timestamp type with a format pattern.

Field name	Type	Description
`type`	string enum	Discriminator for a patterned data type. Must be `PATTERNED`.
`baseType`	string enum	Base simple type. Allowed: `DATE`, `TIMESTAMP`.
`pattern`	string	Format pattern for the value, for example `yyyy-MM-dd` or `yyyyMMdd`.

Get a STANDARD_REPORT report definition response ARRAYDATATYPE object

Array of another data type.

Field name	Type	Description
`type`	string enum	Discriminator for an array data type. Must be `ARRAY`.
`elementType`		Logical data type of a field or parameter, represented as a discriminated union: `SIMPLE` for basic primitive types, `PATTERNED` for dates and timestamps with a format, and `ARRAY` for arrays of another data type.

Get a STANDARD_REPORT report definition response example

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string",
  "templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "templateName": "string",
  "templateDisplayName": "string",
  "templateType": "STANDARD_REPORT",
  "category": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "createdDateTime": "2026-06-10T18:41:32.502Z",
  "modifiedDateTime": "2026-06-10T18:41:32.502Z",
  "status": "ACTIVE",
  "parameters": [
    {
      "parameterId": "string",
      "displayName": "string",
      "dataType": {
        "type": "SIMPLE",
        "baseType": "TEXT"
      },
      "value": "string",
      "values": [
        "string"
      ]
    }
  ],
  "format": "CSV"
}

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

Run report definition request

Only the reportId is required as a path parameter.

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

Run report definition request example

curl --request POST \
     --url https://platform-reporting.vertexcloud.com/api/v1/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6/results \
     --header 'accept: application/json'

Run report definition response

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

Field	Type	Description
`reportResultId`	uuid	Unique identifier of the report result.
`reportResultName`	string	Human-readable name of this report result.
`reportId`	uuid	Identifier of the underlying report definition, if available.
`reportName`	string	Human-readable name of the report run.
`templateId`	uuid	Unique identifier of the template used for the report execution.
`templateName`	string	Name of the template used for the report execution.
`templateDisplayName`	string	Display name of the report template.
`category`	object	Report category. Contains: `id` (UUID), `name` (string).
`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. Allowed: `PENDING`, `PROCESSING`, `COMPLETED`, `CANCELED`, `FAILED`.
`error`	object \| null	Error details for a failed report result.
`processedRecordCount`	int32 \| null	Number of records processed in this report execution.
`output`	object \| null	Metadata for the generated artifact, without a download URL.

Run report definition Error object

Object	Type	Description
code	string enum	Classification code indicating why the report generation failed. Allowed: `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`.
message	string \| null	Detailed error message describing what went wrong during report generation.

Run report definition Output object

Object	Type	Description
fileName	string	Name of the generated output file.
fileSize	int64	Size of the generated output file in bytes.
format	string enum	File format of the generated report. Allowed: `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

Run report definition 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",
  "processedRecordCount": 1,
  "output": {
    "fileName": "string",
    "fileSize": 0,
    "format": "CSV",
    "compression": "GZIP"
  }
}

Update report definition

Update an existing saved report definition. Only the report name plus DATA_EXTRACT filters, fields, and settings or STANDARD_REPORT parameters can be changed.

Request URL:

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

Update report definition request

The reportId parameter is required as a path parameter.

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

Either DATA_EXTRACT or STANDARD_REPORT are required as a body parameter indicator.

Update a DATA_EXTRACT report definition request

Parameter name	Parameter format	Parameter description
`templateType` Required	string enum	Discriminator indicating this is a `DATA_EXTRACT` report request.
`name` Required	string	Name of the report definition. Length must be 1 to 60 characters.
`description`	string \| null	Optional description of the report definition.
`filters`	array of objects	Filters applied when the report definition is executed. Length must be greater than or equal to 0.
`filterLogic`	string \| null	Custom filter combination logic such as `1 AND (2 OR 3)`. When null, filters are combined with `AND`.
`fields`	array of objects	Selected fields for the report. Each field name must match a field available in the associated template. Length must be greater than or equal to 1.
`format`	string enum	File format of the generated report. Allowed: `CSV`, `HTML`, `PDF`, `RTF`, `XML`, `XLS`, `XLSX`, `TXT`.
`settings`	object \| null	Display and render settings for `DATA_EXTRACT` reports. Which settings are applicable depends on the chosen output format.

Update a DATA_EXTRACT report definition request Filters array objects

Filter definition applied in a DATA_EXTRACT report definition.

Parameter name	Parameter format	Parameter description
`targetKey` Required	string	Identifier of the filter target `FIELD`. Length must be equal to or greater than 1.
`displayName` Required	string \| null	Human-readable label of the filter target, if available.
`filterOperator`	string enum	Operator used to apply the filter (to compare the filter value with the field value). Allowed: `EQUALS`, `NOT_EQUALS`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`, `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `IN`, `NOT_IN`, `CONTAINS`, `NOT_CONTAINS`, `STARTS_WITH`, `NOT_STARTS_WITH`, `ENDS_WITH`, `NOT_ENDS_WITH`, `IS_NULL`, `IS_NOT_NULL`, `IN_TIME_PERIOD`, `EQUALS_MIN_VALUE`, `EQUALS_MAX_VALUE`.
`value`	string	Filter value encoded as string for single-value operators.
`values`	array of strings \| null	Values for multi-value operators such as `IN` or `NOT_IN`.

Update DATA_EXTRACT report definition request Fields array objects

Writable field configuration for a custom DATA_EXTRACT template. The field name must reference a field from the base template.

Parameter name	Parameter format	Parameter description
`name` Required	string	Field name (must match a field from the base template). Length must be equal to or greater than 1.
`position` Required	int32	Display position of the field.
`sortOrder` Required	string enum	Sort order applied to a field. Allowed: `NONE`, `ASCENDING`, `DESCENDING`.
`function` Required	string enum	Aggregation or grouping function applied to a field. Allowed: `NONE`, `SUM`, `AVERAGE`, `COUNT`, `COUNT_DISTINCT`, `GROUP`, `MAX`, `MIN`.
`visualGroupIndicator` Required	boolean \| null	Whether this field is used as a visual group indicator.
`alignment`	string enum	Text alignment for a field. Allowed: `LEFT`, `RIGHT`, `CENTER`.
`width`	int 32 \| null	Column width hint. Unit is renderer-specific. Must be an integer between 0 to 99999999.
`wrapIndicator` Required	boolean \| null	Whether to wrap text in this column.
`columnLabel`	string \| null	Custom display name for the column header.

Update a DATA_EXTRACT report definition request Settings object

Parameter name	Parameter format	Parameter description
`showColumnHeaders`	boolean	Show column headers in the report output (XLS, XLSX, HTML, PDF, RTF).
`showRecordCount`	boolean	Show total record count (HTML, PDF, RTF).
`showTotals`	boolean	Show totals row (HTML, PDF, RTF).
`showRowNumbers`	boolean	Show row numbers (HTML, PDF, RTF).
`showDataSource`	boolean	Show data source information (HTML, PDF, RTF)
`showFilters`	boolean	Show applied filters in the output (HTML, PDF, RTF).
`showUniqueRows`	boolean	Show only unique rows (all formats).
`pageOrientation`	string enum	Page orientation (PDF, RTF). Allowed: `PORTRAIT`, `LANDSCAPE`.
`textQualifier`	string \| null	Character used to qualify text fields, such as double-quote (CSV).
`fieldDelimiter`	string \| null	Character used to delimit fields, such as comma, tab (CSV).
`recordLimit`	integer \| null ≥ 1	Maximum number of records in the report output, `null` means unlimited.
`zipReport`	boolean	Whether to compress the report output as a ZIP archive.

Update a DATA_EXTRACT report definition request example

curl --request PUT \
     --url https://platform-reporting.vertexcloud.com/api/v1/reports/reportId \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "templateType": "DATA_EXTRACT",
  "fields": [
    {
      "sortOrder": "NONE",
      "function": "NONE",
      "visualGroupIndicator": true,
      "wrapIndicator": true
    }
  ],
  "format": "CSV",
  "filters": [
    {
      "filterOperator": "EQUALS"
    }
  ]
}
'

Update a DATA_EXTRACT report definition response

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 definition (read-only).
`templateId`	string (UUID)	Identifier of the template used by this report definition.
`templateName`	string	Name of template that this report definition is based on.
`templateDisplayName`	string	Display name of the template that this report definition is based on.
`templateType`	string	Type of report request, in this case `DATA_EXTRACT`.
`category`	object	Report category. Contains: `id` (UUID), `name` (string).
`createdDateTime`	string (ISO-8601 datetime)	Creation timestamp of the report definition.
`modifiedDateTime`	string (ISO-8601 datetime)	Last modification timestamp of the report definition.
`status`	string	Lifecycle status of the report definition. Either `ACTIVE` or `ARCHIVED`.
`fields`	array of objects	Selected `DATA_EXTRACT` fields for this report definition. Each field name must match a field available in the associated template.
`filters`	array of objects	Filter definitions applied when this report definition is executed.
`filterLogic`	string \| null	Custom filter combination logic such as `1 AND (2 OR 3)`. When null, filters are combined with `AND`.
`format`	string enum	File format of the generated report. Allowed: `CSV`, `HTML`, `PDF`, `RTF`, `XML`, `XLS`, `XLSX`, `TXT`.
`settings`	object \| null	Display and render settings for `DATA_EXTRACT` reports. Which settings are applicable depends on the chosen output format.

Update a DATA_EXTRACT report definition response Fields array of objects

A response includes the ReportDefinitionField object.

Field name	Type	Description
`name` Required	string	Field name (must match a field from the base template). Length must be equal to or greater than 1.
`dataType`		Logical data type of a field or parameter, represented as a discriminated union: `SIMPLE` for basic primitive types, `PATTERNED` for dates and timestamps with a format, and `ARRAY` for arrays of another data type.
`position` Required	int32 \| null	Position of the field within the report.
`sortOrder` Required	string enum	Sort order applied to a field. Allowed: `NONE`, `ASCENDING`, `DESCENDING`.
`function` Required	string enum	Aggregation or grouping function applied to a field. Allowed: `NONE`, `SUM`, `AVERAGE`, `COUNT`, `COUNT_DISTINCT`, `GROUP`, `MAX`, `MIN`.
`visualGroupIndicator` Required	boolean \| null	Indicates whether this field is used as a visual group or break.
`format`	string enum	Display format for a field value. Allowed: `USA_DATE`, `USA_DATE_TIME`, `SHORT_DATE`, `MEDIUM_DATE`, `LONG_DATE`, `UNIVERSAL_DATE`, `CURRENCY`, `YES_NO`, `NUMBER`.
`alignment`	string enum	Text alignment for a field. Allowed: `LEFT`, `RIGHT`, `CENTER`.
`width`	int 32 \| null	Column width hint. Unit is renderer-specific. Must be an integer between 0 to 99999999.
`wrapIndicator` Required	boolean \| null	Whether to wrap text in this column.

Update a DATA_EXTRACT report definition response SIMPLEDATATYPE object

Simple base type without additional metadata.

Field name	Type	Description
`type` Required	string enum	Discriminator for a simple data type. Must be `SIMPLE`.
`baseType` Required	string enum	Base simple type. Allowed: `TEXT`, `NUMBER`, `BOOLEAN`, `DECIMAL`, `CURRENCY`.

Update a DATA_EXTRACT report definition response PATTERNEDDATATYPE object

Date or timestamp type with a format pattern.

Field name	Type	Description
`type` Required	string enum	Discriminator for a patterned data type. Must be `PATTERNED`.
`baseType` Required	string enum	Base simple type. Allowed: `DATE`, `TIMESTAMP`.
`pattern` Required	string	Format pattern for the value, for example `yyyy-MM-dd` or `yyyyMMdd`.

Update a DATA_EXTRACT report definition response ARRAYDATATYPE object

Array of another data type.

Field name	Type	Description
`type` Required	string enum	Discriminator for an array data type. Must be `ARRAY`.
`elementType`	string enum	Logical data type of a field or parameter, represented as a discriminated union: `SIMPLE` for basic primitive types, `PATTERNED` for dates and timestamps with a format, and `ARRAY` for arrays of another data type.

Update a DATA_EXTRACT report definition response Filters array of objects

A response includes the ReportDefinitionFilter object.

Field name	Type	Description
`targetKey` Required	string	Identifier of the filter target `FIELD`.
`displayName`	string \| null	Human-readable label of the filter target, if available.
`dataType`	string enum	Data type of the filter value. Allowed: `ArrayDataType`, `PatternedDataType`, `SimpleDataType`.
`filterOperator`	string enum	Operator used to apply the filter (to compare the filter value with the field value). Allowed: `EQUALS`, `NOT_EQUALS`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`, `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `IN`, `NOT_IN`, `CONTAINS`, `NOT_CONTAINS`, `STARTS_WITH`, `NOT_STARTS_WITH`, `ENDS_WITH`, `NOT_ENDS_WITH`, `IS_NULL`, `IS_NOT_NULL`, `IN_TIME_PERIOD`, `EQUALS_MIN_VALUE`, `EQUALS_MAX_VALUE`.
`value`	string	Filter value encoded as string for single-value operators.
`values`	array of strings \| null	Values for multi-value operators such as `IN` or `NOT_IN`.

Update a DATA_EXTRACT report definition response Settings object

Field name	Type	Description
`showColumnHeaders`	boolean	Show column headers in the report output (XLS, XLSX, HTML, PDF, RTF).
`showRecordCount`	boolean	Show total record count (HTML, PDF, RTF).
`showTotals`	boolean	Show totals row (HTML, PDF, RTF).
`showRowNumbers`	boolean	Show row numbers (HTML, PDF, RTF).
`showDataSource`	boolean	Show data source information (HTML, PDF, RTF)
`showFilters`	boolean	Show applied filters in the output (HTML, PDF, RTF).
`showUniqueRows`	boolean	Show only unique rows (all formats).
`pageOrientation`	string enum	Page orientation (PDF, RTF). Allowed: `PORTRAIT`, `LANDSCAPE`.
`textQualifier`	string \| null	Character used to qualify text fields, such as double-quote (CSV).
`fieldDelimiter`	string \| null	Character used to delimit fields, such as comma, tab (CSV).
`recordLimit`	integer \| null ≥ 1	Maximum number of records in the report output, `null` means unlimited.
`zipReport`	boolean	Whether to compress the report output as a ZIP archive.

Update a DATA_EXTRACT report definition response example

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string",
  "templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "templateName": "string",
  "templateDisplayName": "string",
  "templateType": "DATA_EXTRACT",
  "category": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "createdDateTime": "2026-06-09T20:06:08.008Z",
  "modifiedDateTime": "2026-06-09T20:06:08.008Z",
  "status": "ACTIVE",
  "parameters": [
    {
      "parameterId": "string",
      "displayName": "string",
      "dataType": {
        "type": "SIMPLE",
        "baseType": "TEXT"
      },
      "value": "string",
      "values": [
        "string"
      ]
    }
  ],
  "format": "CSV"
}

Update a STANDARD_REPORT report definition request

Parameter name	Parameter format	Parameter description
`templateType` Required	string enum	Discriminator indicating this is a `STANDARD_REPORT` report request.
`name` Required	string	Name of the report definition. Length must be 1 to 30 characters
`description`	string \| null	Optional description of the report definition.
`parameters`	array of objects	Filters applied when the report definition is executed.
`format`	string enum	File format of the generated report. Allowed: `CSV`, `HTML`, `PDF`, `RTF`, `XML`, `XLS`, `XLSX`, `TXT`.

Update a STANDARD_REPORT report definition request Parameters array objects

Parameter definition applied in a STANDARD_REPORT report definition.

Parameter name	Parameter format	Parameter description
`parameterId` Required	string	Identifier of the template parameter.
`value`	string	Filter value encoded as string for single-value operators.
`values`	array of strings \| null	Values for multi-value operators such as `IN` or `NOT_IN`.

Update a STANDARD_REPORT report definition request example

curl --request PUT \
     --url https://platform-reporting.vertexcloud.com/api/v1/reports/reportId \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "templateType": "STANDARD_REPORT",
  "format": "CSV",
  "parameters": [
    {
      "values": []
    }
  ]
}
'

Update a STANDARD_REPORT report definition response

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 definition (read-only).
`templateId`	string (UUID)	Identifier of the template used by this report definition.
`templateName`	string	Name of template that this report definition is based on.
`templateDisplayName`	string	Display name of the template that this report definition is based on.
`templateType`	string enum	Template classification. In this case `STANDARD_REPORT`.
`category`	object	Report category. Contains: `id` (UUID), `name` (string).
`createdDateTime`	string (ISO-8601 datetime)	Creation timestamp of the report definition.
`modifiedDateTime`	string (ISO-8601 datetime)	Last modification timestamp of the report definition.
`status`	string enum	Lifecycle status of the report definition. Allowed: `ACTIVE` or `ARCHIVED`.
`parameters`	array of objects	Parameter values applied when this report definition is executed.
`format`	string enum	File format of the generated report. Allowed: `CSV`, `HTML`, `PDF`, `RTF`, `XML`, `XLS`, `XLSX`, `TXT`.

Update a STANDARD_REPORT report definition response ReportDefinitionParameter object

Field name	Type	Description
`parameterId`	string	Identifier of the template parameter.
`displayName`	string \| null	Human-readable parameter label, if available.
`dataType`	string enum	Logical data type of a field or parameter, represented as a discriminated union: `SIMPLE` for basic primitive types, `PATTERNED` for dates and timestamps with a format, and `ARRAY` for arrays of another data type.
`value`	string	Value encoded as string for single-value parameters.
`values`	array of strings \| null	Values for multi-value parameters.

Update a STANDARD_REPORT report definition response Filters ReportDefinitionParameter SIMPLEDATATYPE object

Simple base type without additional metadata.

Field name	Type	Description
`type`	string enum	Discriminator for a simple data type. Must be `SIMPLE`.
`baseType`	string enum	Base simple type. Allowed: `TEXT`, `NUMBER`, `BOOLEAN`, `DECIMAL`, `CURRENCY`.

Update a STANDARD_REPORT report definition response ReportDefinitionParameter PATTERNEDDATATYPE object

Date or timestamp type with a format pattern.

Field name	Type	Description
`type`	string enum	Discriminator for a patterned data type. Must be `PATTERNED`.
`baseType`	string enum	Base simple type. Allowed: `DATE`, `TIMESTAMP`.
`pattern`	string	Format pattern for the value, for example `yyyy-MM-dd` or `yyyyMMdd`.

Update a STANDARD_REPORT report definition response ReportDefinitionParameter ARRAYDATATYPE object

Array of another data type.

Field name	Type	Description
`type`	string enum	Discriminator for an array data type. Must be `ARRAY`.
`elementType`	object	Logical data type of a field or parameter, represented as a discriminated union: `SIMPLE` for basic primitive types, `PATTERNED` for dates and timestamps with a format, and `ARRAY` for arrays of another data type. The `ARRAY` object can include nested objects.

Update a STANDARD_REPORT report definition response example

{
  "templateType": "STANDARD_REPORT",
  "id": "7e3c0a9d-5d4e-4562-b3fc-2c963f66afa6",
  "name": "My Sales Tax Report",
  "description": null,
  "templateId": "4b2d9b5d-ab8d-4b2d-9b5d-ab8dfbbd4bed",
  "templateName": "sales_tax_template",
  "templateDisplayName": "Sales Tax Report Template",
  "category": {
    "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "name": "Tax Reports"
  },
  "createdDateTime": "2024-01-15T10:30:00Z",
  "modifiedDateTime": "2024-01-15T10:30:00Z",
  "status": "ACTIVE",
  "parameters": [
    {
      "parameterId": "PERIOD",
      "displayName": "Period",
      "dataType": {
        "type": "PATTERNED",
        "baseType": "DATE",
        "pattern": "yyyy-MM"
      },
      "value": "2024-01",
      "values": null
    }
  ],
  "format": "PDF"
}

Archive report definition

Soft-delete a report definition by moving it to ARCHIVED status. Archiving a report deactivates all of its schedules. Archived reports remain readable but can no longer be updated or run. The operation is idempotent — it 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/{reportId}

Archive report definition request

Only the reportId parameter is required as a path parameter.

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

Archive report definition request example

curl --request DELETE \
     --url https://platform-reporting.vertexcloud.com/api/v1/reports/7e3c0a9d-5d4e-4562-b3fc-2c963f66afa6 \
     --header 'accept: application/json'

Archive report definition response

Report definition archived successfully or was already archived.

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