Expectation Incidents

An ExpectationIncident groups ongoing failure behavior for an Expectation over time.

List Expectation Incidents

SDK Method

files_sdk.expectation_incident.list()

Return Object

ListObj[ExpectationIncident]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

import files_sdk

try:
  expectation_incidents = files_sdk.expectation_incident.list()
  for expectation_incident in expectation_incidents.auto_paging_iter():
    # Operate on expectation_incident
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Show Expectation Incident

SDK Method

files_sdk.expectation_incident.find()

Return Object

ExpectationIncident

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		Expectation Incident ID.

Example Request

import files_sdk

try:
  expectation_incident = files_sdk.expectation_incident.find(id)
  # Operate on expectation_incident
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Resolve an expectation incident

SDK Method

expectation_incident.resolve()

Return Object

ExpectationIncident

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

import files_sdk

try:
  # Find the expectation_incident object by its id.
  expectation_incident = files_sdk.expectation_incident.find(id)
  expectation_incident.resolve()
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Snooze an expectation incident until a specified time

SDK Method

expectation_incident.snooze()

Return Object

ExpectationIncident

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
snoozed_until
string
Required		Time until which the incident should remain snoozed.

Example Request

import files_sdk

try:
  # Find the expectation_incident object by its id.
  expectation_incident = files_sdk.expectation_incident.find(id)
  expectation_incident.snooze({
    "snoozed_until": "snoozed_until"
  })
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Acknowledge an expectation incident

SDK Method

expectation_incident.acknowledge()

Return Object

ExpectationIncident

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

import files_sdk

try:
  # Find the expectation_incident object by its id.
  expectation_incident = files_sdk.expectation_incident.find(id)
  expectation_incident.acknowledge()
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

The ExpectationIncident Object

Some of the methods above return a ExpectationIncident object. The attributes of this object are listed below.

AttributeDescription
id
int64		Expectation Incident ID
workspace_id
int64		Workspace ID. 0 means the default workspace.
expectation_id
int64		Expectation ID.
status
string		Incident status.
Possible values: open, acknowledged, snoozed, resolved
opened_at
date-time		When the incident was opened.
last_failed_at
date-time		When the most recent failing evaluation contributing to the incident occurred.
acknowledged_at
date-time		When the incident was acknowledged.
snoozed_until
date-time		When the current snooze expires.
resolved_at
date-time		When the incident was resolved.
opened_by_evaluation_id
int64		Evaluation that first opened the incident.
last_evaluation_id
int64		Most recent evaluation linked to the incident.
resolved_by_evaluation_id
int64		Evaluation that resolved the incident.
summary
object		Compact incident summary payload.
created_at
date-time		Creation time.
updated_at
date-time		Last update time.