API Reference

Create report definition

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

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

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

Request to create 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

Name of the report definition

string | null

Optional description of the report definition

uuid
required

UUID of the template used to create the report definition

filters
array of objects
length ≥ 0

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

Selected fields 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?