Update report
Partially update a saved report. view_config is a typed, merge-only
patch: omitted supported fields, unknown compatible stored view fields,
metric_config, ownership, IDs, and permissions remain unchanged.
Send the ETag returned by GET /reports/{report_id} in If-Match
whenever view_config is present. A stale value is rejected with 412.
The legacy top-level compare_by and metadata_key fields remain
available for backward compatibility.
Authorizations
API key for authentication
Headers
Strong ETag from GET /reports/{report_id}. Required when the PATCH
body contains view_config; omit for legacy non-configuration updates.
Path Parameters
Saved report ULID.
26Body
Display name for the saved report.
1 - 200"Q2 plan comparison"
Replacement run IDs. All must belong to the authenticated organization.
1 - 2000 elementsReplacement simulation IDs pinning the report to a subset of simulations. When set, this is the report's authoritative scope.
10000Human review project the simulations were sourced from; simulation_output_ids
must belong to it. Omit to leave unchanged — null is rejected, the linkage
cannot be cleared via update.
26"01JABCDEFGHJKMNPQRSTVWXYZ0"
Dimension to group and compare runs by in the report view. custom groups by a
caller-defined dimension and requires custom_dimensions.
none, run, agent, mutation, persona, test_case, metadata, custom "persona"
Required when changing compare_by to metadata; otherwise omit it.
1 - 200"customer.plan"
PUBLIC creates a login-free shareable report; PRIVATE keeps it organization-only.
PUBLIC, PRIVATE "PRIVATE"
Merge-only patch for supported report view fields. Requires
If-Match; cannot be combined with the legacy top-level
compare_by or metadata_key fields.
Response
Report updated successfully