API Reference

List report definitions

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

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
templateId
array of uuids

Filter by template UUID (supports multiple values: ?templateId=id1&templateId=id2)

templateId
string
enum

Filter by template type

Allowed:
string

Filter by template name (case-insensitive substring match)

categoryId
array of uuids

Filter by report category UUID (supports multiple values: ?categoryIds=id1&categoryIds=id2)

categoryId
string

Filter by report definition name (case-insensitive substring match)

date

ISO-8601 creation start date (inclusive)

date

ISO-8601 creation end date (inclusive)

string
enum
Defaults to ACTIVE

Filter by report definition lifecycle status

Allowed:
integer
≥ 0
Defaults to 0

Number of items to skip (for pagination)

int32
≥ 1
Defaults to 100

Maximum number of items to return

string
enum
Defaults to NAME

Field to sort by

Allowed:
string
enum
Defaults to ASC

Sort direction

Allowed:
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?