Skip to main content
PATCH
Update an insight

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

If-Match
string | null

The insight's current ETag, from a prior read. Required: the update is rejected if the insight has changed since.

x-tenant-id
string
required

The organization ID the request is scoped to.

Path Parameters

insight_id
string
required

Body

application/json

The fields of an insight you can change.

Omit a field to leave it unchanged; send null to clear it. Fields SELECT generates cannot be set.

status
enum<string> | null

Workflow status of the insight. Set it to dismissed to dismiss the insight. Cannot be null.

Available options:
open,
backlog,
resolved,
dismissed
assignee
string | null

Email address of the user to assign this insight to. The assignee is subscribed to the insight's activity feed. Send null to unassign.

user_effort
string | null

Effort estimate for this insight, overriding SELECT's estimate. Send null to fall back to SELECT's estimate.

user_annualized_potential_savings_lower_bound
number | null

Lower bound of the annualized savings for this insight, overriding SELECT's estimate. Send null to fall back to SELECT's estimate.

user_annualized_potential_savings_upper_bound
number | null

Upper bound of the annualized savings for this insight, overriding SELECT's estimate. Send null to fall back to SELECT's estimate.

Response

Successful Response

A single insight — an optimization opportunity SELECT has surfaced for one of your resources.

id
string
required
read-only

The unique identifier of the insight.

etag
string
required
read-only

Opaque strong ETag for optimistic concurrency. Matches the ETag response header; supply it in an If-Match header on a later update to make that write conditional and avoid overwriting newer changes.

create_time
string
required
read-only

When the insight was first created, as an RFC 3339 UTC timestamp.

update_time
string
required
read-only

When the insight was last updated, as an RFC 3339 UTC timestamp.

account_metadata
any
required
read-only

Details of the account this insight relates to.

view_count
integer
required
read-only

Number of distinct days this insight was viewed by anyone in your organization. 0 if it has never been viewed.

status
string
required

Current workflow status of the insight: open, backlog, resolved or dismissed.

snowflake_id
string | null

Stable identifier for the insight, carried through from the source data. It stays the same across syncs and only changes if the insight is regenerated.

is_current
boolean | null

Whether this is the current, active version of the insight for its resource. Superseded insights stay queryable but are marked not current.

connection_id
string | null

Identifier of the connection this insight was generated for.

connection_type
string | null

The type of connection this insight was generated for.

resource_type
string | null

The type of resource this insight is about, such as a warehouse.

aggregate_resource_type
string | null

When the insight covers a group of resources, the type of those resources.

insight_type
string | null

The category of optimization opportunity this insight describes.

identifying_metadata
any | null

Details identifying the specific resource this insight applies to.

aggregate_metadata
any | null

Additional details for insights that span multiple resources.

usage_groups
any | null

The usage groups associated with this insight.

insight_metadata
any | null

Additional details specific to this insight's type.

effort
string | null

Estimated effort required to act on this insight.

studied_period_start
string<date> | null

Start of the time period analyzed to produce this insight.

studied_period_end
string<date> | null

End of the time period analyzed to produce this insight.

annualized_potential_savings_lower_bound
number | null

Lower bound of the estimated annualized savings if this insight is acted on.

annualized_potential_savings_upper_bound
number | null

Upper bound of the estimated annualized savings if this insight is acted on.

last_generated_time
string | null

When this insight was most recently generated, as an RFC 3339 UTC timestamp.

first_generated_time
string | null

When this insight was first generated, as an RFC 3339 UTC timestamp.

first_view_time
string | null

When this insight was first viewed by anyone in your organization, as an RFC 3339 UTC timestamp. Null if it has never been viewed.

last_view_time
string | null

When this insight was most recently viewed by anyone in your organization, as an RFC 3339 UTC timestamp. Null if it has never been viewed.

first_viewed_by
string | null

Email address of the first user in your organization to view this insight. Null if it has never been viewed.

last_viewed_by
string | null

Email address of the most recent user in your organization to view this insight. Null if it has never been viewed.

assignee
string | null

Email address of the user this insight is assigned to.

user_effort
string | null

Effort estimate you have set for this insight, overriding SELECT's estimate.

user_annualized_potential_savings_lower_bound
number | null

Lower bound of the annualized savings you have set for this insight, overriding SELECT's estimate.

user_annualized_potential_savings_upper_bound
number | null

Upper bound of the annualized savings you have set for this insight, overriding SELECT's estimate.