API Reference

Update report definition

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

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

UUID of the report definition

Body Params

Request to update a DATA_EXTRACT report definition

string
enum
required

Discriminator indicating this is a DATA_EXTRACT report request

Allowed:
string
required
length between 1 and 60

Updated name of the report definition

string | null

Optional description of the report definition

filters
array of objects
length ≥ 0

Updated filters applied when the report definition is executed

filters
string | null

Custom filter combination logic (e.g. "1 AND (2 OR 3)"). When null, filters are combined with AND.

fields
array of objects
required
length ≥ 1

Updated field selection for the report. Each field name must match a field available in the associated template.

fields*
string
enum
required

File format of the generated report

settings
object | null

Display and rendering settings for DATA_EXTRACT reports. Which settings are applicable depends on the chosen output format.

Responses

Updated 13 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 13 days ago

Did this page help you?