Alerts

Reference for client.alerts in the Future AGI Python and TypeScript SDKs: alerts.logs.list, alerts.rules.list.

client.alerts on fi.Client (Python) and client.alerts on Client from @future-agi/sdk (TypeScript), with the nested resources client.alerts.logs, client.alerts.rules. The models these methods return are on Observability response models; how arguments, pagination, errors and strict mode work is in the overview.

Methods

MethodDescription
alerts.logs.listList alerts that have fired in numbered pages.
alerts.rules.listList the configured alert monitors - what each one watches, its threshold and its project.

client.alerts

client.alerts.logs

TypeScript: client.alerts.logs.

alerts.logs.list

List alerts that have fired in numbered pages. Use this to find out what the platform has already flagged before digging into traces or error clusters.

GET /tracer/user-alert-logs/

Paginated: returns a pager (how pagination works) · MCP tool: list_fired_alerts

for item in client.alerts.logs.list():
    print(item)
for await (const item of client.alerts.logs.list()) {
  console.log(item);
}
Signature
client.alerts.logs.list(
    *,
    limit: int | None | NotGiven = NOT_GIVEN,
    extra_query: dict[str, Any] | None = None,
    options: RequestOptions | None = None,
) -> SyncPager[models.UserAlertMonitorLog]
client.alerts.logs.list(params: AlertsLogsListParams = {}, options?: RequestOptions): Pager<models.UserAlertMonitorLog>

export interface AlertsLogsListParams {
  /** Number of results to return per page. */
  limit?: number | null;
}

Parameters

limit integer Optional

Number of results to return per page.

The pager sends page itself; pass limit to change the page size.

Returns

A pager of UserAlertMonitorLog items: iterate it, or call to_list() (Python) / toArray() (TypeScript).

client.alerts.rules

TypeScript: client.alerts.rules.

alerts.rules.list

List the configured alert monitors - what each one watches, its threshold and its project. Pair with list_fired_alerts to explain why an alert fired, or to see that no monitor covers a condition the user expected to be caught.

GET /tracer/user-alerts/list_monitors/

MCP tool: list_alert_rules

result = client.alerts.rules.list()
const result = await client.alerts.rules.list();
Signature
client.alerts.rules.list(
    *,
    page_number: int | None | NotGiven = NOT_GIVEN,
    page_size: int | None | NotGiven = NOT_GIVEN,
    search_text: str | None | NotGiven = NOT_GIVEN,
    project_id: list[str] | None | NotGiven = NOT_GIVEN,
    status: list[Literal['triggered', 'healthy']] | None | NotGiven = NOT_GIVEN,
    metric_type: list[str] | None | NotGiven = NOT_GIVEN,
    sort_by: str | None | NotGiven = NOT_GIVEN,
    sort_direction: Literal['asc', 'desc'] | None | NotGiven = NOT_GIVEN,
    extra_query: dict[str, Any] | None = None,
    options: RequestOptions | None = None,
) -> models.UserAlertMonitorListResult
client.alerts.rules.list(params: AlertsRulesListParams = {}, options?: RequestOptions): Promise<models.UserAlertMonitorListResult>

export interface AlertsRulesListParams {
  /** Zero-based page number. */
  page_number?: number | null;
  page_size?: number | null;
  search_text?: string | null;
  project_id?: Array<string> | null;
  status?: Array<"triggered" | "healthy"> | null;
  metric_type?: Array<string> | null;
  sort_by?: string | null;
  sort_direction?: "asc" | "desc" | null;
}

Parameters

page_number integer Optional

Zero-based page number.

page_size integer Optional
search_text string Optional
project_id string[] Optional
status string[] Optional
metric_type string[] Optional
sort_by string Optional
sort_direction string Optional
Allowed values:
ascdesc

Returns

UserAlertMonitorListResult.

Was this page helpful?

Questions & Discussion