Patch

/reports/{report_id}

Update specific fields of an existing report without replacing the entire resource

Path parameters

report_id

stringRequired

Unique identifier of the report

Body parameters

Expand All

object

report_name

string

Name of the report

Min length1

Max length100

description

string

Optional description of the report

Max length500

metric_names

Array of string

List of metric names to query (1-10 metrics, e.g. ["http_requests", "memory_usage", "dataengine.function.invocations"]). Each name allows alphanumeric characters, dots, colons, underscores, hyphens, and slashes.

Min items1

Max items10

string

aggregation

string

Aggregation method (defaults to 'avg')

Valid values[ "sum", "avg", "min", "max", "p50", "p95", "p99" ]

timeframe

string

Time window like '30s', '5m', '1h', '7d'. Defaults to '1h' if not specified.

max_points

integer

Maximum data points to return (defaults to 60)

Minimum1

Maximum100

pipeline

string

Pipeline name filter (optional)

function

string

Function name filter (optional)

function_deployment

string

Function deployment name filter (optional)

metric_type

string

Type of metric (Counter, Histogram, Gauge, UpDownCounter)

Valid values[ "Counter", "Histogram", "Gauge", "UpDownCounter" ]

group_by

string

Dimension to group metrics by (function_name, pipeline_name, or function_deployment_name)

Valid values[ "function_name", "pipeline_name", "function_deployment_name" ]

top_k

integer

Return only the top K groups with highest values (requires group_by, mutually exclusive with bottom_k) (optional)

Minimum1

Maximum100

bottom_k

integer

Return only the bottom K groups with lowest values (requires group_by, mutually exclusive with top_k) (optional)

Minimum1

Maximum100

display_config

object

Optional display configuration for GUI visualization (no server-side validation, GUI can store any JSON structure)

is_used_in_dashboard

boolean

Flag indicating if this report is used in a dashboard

Defaultfalse

Responses

200

Report updated successfully

Expand All

object

report_name

string

Name of the report

Min length1

Max length100

description

string

Optional description of the report

Max length500

metric_names

Array of string

List of metric names to query (1-10 metrics, e.g. ["http_requests", "memory_usage", "dataengine.function.invocations"]). Each name allows alphanumeric characters, dots, colons, underscores, hyphens, and slashes.

Min items1

Max items10

string

aggregation

string

Aggregation method (defaults to 'avg')

Valid values[ "sum", "avg", "min", "max", "p50", "p95", "p99" ]

timeframe

string

Time window like '30s', '5m', '1h', '7d'. Defaults to '1h' if not specified.

max_points

integer

Maximum data points to return (defaults to 60)

Minimum1

Maximum100

pipeline

string

Pipeline name filter (optional)

function

string

Function name filter (optional)

function_deployment

string

Function deployment name filter (optional)

metric_type

string

Type of metric (Counter, Histogram, Gauge, UpDownCounter)

Valid values[ "Counter", "Histogram", "Gauge", "UpDownCounter" ]

group_by

string

Dimension to group metrics by (function_name, pipeline_name, or function_deployment_name)

Valid values[ "function_name", "pipeline_name", "function_deployment_name" ]

top_k

integer

Return only the top K groups with highest values (requires group_by, mutually exclusive with bottom_k) (optional)

Minimum1

Maximum100

bottom_k

integer

Return only the bottom K groups with lowest values (requires group_by, mutually exclusive with top_k) (optional)

Minimum1

Maximum100

display_config

object

Optional display configuration for GUI visualization (no server-side validation, GUI can store any JSON structure)

is_used_in_dashboard

boolean

Flag indicating if this report is used in a dashboard

Defaultfalse

report_id

string (uuid)

Unique identifier for a report (server-generated UUID)

owner_vid

integer (int64)

User ID (VID) of the report owner (server-generated)

created_at

string (date-time)

When the report was created

updated_at

string (date-time)

When the report was last modified

last_executed_at

string (date-time)

When the report was last executed

execution_count

integer

Number of times the report has been executed

404

Not Found

Expand All

object

detail

string

source

object (ErrorSource)

Represents the underlying problem that made Data Engine raise the error

source_type

string

The component where the error happened

Examplekubernetes | vms | vdb | registry

source_name

string

The name of the source compoenent

Examplemy-cluster

inner_error

string

The error message from the source component

ExampleFailed to connect to the cluster

code

string

Optional machine-readable error code for clients to branch on instead of parsing detail.

409

Conflict

Expand All

object

detail

string

source

object (ErrorSource)

Represents the underlying problem that made Data Engine raise the error

source_type

string

The component where the error happened

Examplekubernetes | vms | vdb | registry

source_name

string

The name of the source compoenent

Examplemy-cluster

inner_error

string

The error message from the source component

ExampleFailed to connect to the cluster

code

string

Optional machine-readable error code for clients to branch on instead of parsing detail.

422

Validation Error

object

detail

string

String representation of a mapping between field names and error messages

Example{"url": "URL must include a protocol", "port": "Port must be an integer"}

500

Internal Server Error

Expand All

object

detail

string

source

object (ErrorSource)

Represents the underlying problem that made Data Engine raise the error

source_type

string

The component where the error happened

Examplekubernetes | vms | vdb | registry

source_name

string

The name of the source compoenent

Examplemy-cluster

inner_error

string

The error message from the source component

ExampleFailed to connect to the cluster

code

string

Optional machine-readable error code for clients to branch on instead of parsing detail.

Partially update a report