sift_client.resources.reports

CLASS	DESCRIPTION
ReportsAPIAsync	High-level API for interacting with reports.
ReportTemplatesAPIAsync	High-level API for interacting with report templates.

ReportsAPIAsync

ReportsAPIAsync(sift_client: SiftClient)

Bases: ResourceBase

High-level API for interacting with reports.

Initialize the ReportsAPI.

PARAMETER	DESCRIPTION
sift_client	The Sift client to use. TYPE: SiftClient

METHOD	DESCRIPTION
get	Get a Report.
list_	List reports with optional filtering.
find	Find a single report matching the given query. Takes the same arguments as list. If more than one report is found,
create_from_template	Create a new report from a report template.
create_from_rules	Create a new report from rules.
create_from_applicable_rules	Create a new report from applicable rules based on a run.
create_from_rule_versions	Create a new report from rule versions.
rerun	Rerun a report.
cancel	Cancel a report.
update	Update a report.
archive	Archive a report.
unarchive	Unarchive a report.
wait_until_complete	Wait until the report is complete or the timeout is reached.

ATTRIBUTE	DESCRIPTION
templates	Nested Report Templates API. See ReportTemplatesAPIAsync. TYPE: ReportTemplatesAPIAsync
client	TYPE: SiftClient
grpc_client	TYPE: GrpcClient
rest_client	TYPE: RestClient

templates instance-attribute

templates: ReportTemplatesAPIAsync = (
    ReportTemplatesAPIAsync(sift_client)
)

Nested Report Templates API. See ReportTemplatesAPIAsync.

client property

client: SiftClient

grpc_client property

grpc_client: GrpcClient

rest_client property

rest_client: RestClient

get async

get(*, report_id: str) -> Report

Get a Report.

PARAMETER	DESCRIPTION
report_id	The ID of the report. TYPE: str

RETURNS	DESCRIPTION
Report	The Report.

list_ async

list_(
    *,
    name: str | None = None,
    name_contains: str | None = None,
    name_regex: str | Pattern | None = None,
    names: list[str] | None = None,
    description_contains: str | None = None,
    run: Run | str | None = None,
    organization_id: str | None = None,
    report_ids: list[str] | None = None,
    report_template_id: str | None = None,
    metadata: dict[str, str | float | bool] | None = None,
    tag_names: list[str] | list[Tag] | None = None,
    created_by: str | None = None,
    modified_by: str | None = None,
    order_by: str | None = None,
    limit: int | None = None,
    page_size: int | None = None,
    include_archived: bool = False,
    filter_query: str | None = None,
    created_after: datetime | None = None,
    created_before: datetime | None = None,
    modified_after: datetime | None = None,
    modified_before: datetime | None = None,
) -> list[Report]

List reports with optional filtering.

PARAMETER	DESCRIPTION
name	Exact name of the report. TYPE: str | None DEFAULT: None
name_contains	Partial name of the report. TYPE: str | None DEFAULT: None
name_regex	Regular expression string to filter reports by name. TYPE: str | Pattern | None DEFAULT: None
names	List of report names to filter by. TYPE: list[str] | None DEFAULT: None
description_contains	Partial description of the report. TYPE: str | None DEFAULT: None
run	Run/run ID to filter by. TYPE: Run | str | None DEFAULT: None
organization_id	Organization ID to filter by. TYPE: str | None DEFAULT: None
report_ids	List of report IDs to filter by. TYPE: list[str] | None DEFAULT: None
report_template_id	Report template ID to filter by. TYPE: str | None DEFAULT: None
metadata	Metadata to filter by. TYPE: dict[str, str | float | bool] | None DEFAULT: None
tag_names	List of tags or tag names to filter by. TYPE: list[str] | list[Tag] | None DEFAULT: None
created_by	The user ID of the creator of the reports. TYPE: str | None DEFAULT: None
modified_by	The user ID of the last modifier of the reports. TYPE: str | None DEFAULT: None
order_by	How to order the retrieved reports. TYPE: str | None DEFAULT: None
limit	How many reports to retrieve. If None, retrieves all matches. TYPE: int | None DEFAULT: None
page_size	Number of results to fetch per request. Lower this if you hit gRPC message size limits on responses. If None, uses the server default. TYPE: int | None DEFAULT: None
include_archived	Whether to include archived reports. TYPE: bool DEFAULT: False
filter_query	Explicit CEL query to filter reports. TYPE: str | None DEFAULT: None
created_after	Filter reports created after this datetime. TYPE: datetime | None DEFAULT: None
created_before	Filter reports created before this datetime. TYPE: datetime | None DEFAULT: None
modified_after	Filter reports modified after this datetime. TYPE: datetime | None DEFAULT: None
modified_before	Filter reports modified before this datetime. TYPE: datetime | None DEFAULT: None

RETURNS	DESCRIPTION
list[Report]	A list of Reports that matches the filter.

find async

find(**kwargs) -> Report | None

Find a single report matching the given query. Takes the same arguments as list. If more than one report is found, raises an error.

PARAMETER	DESCRIPTION
**kwargs	Keyword arguments to pass to list. DEFAULT: {}

RETURNS	DESCRIPTION
Report | None	The Report found or None.

create_from_template async

create_from_template(
    *,
    report_template: ReportTemplate | str,
    run: Run | str,
    organization_id: str | None = None,
    name: str | None = None,
) -> Job | None

Create a new report from a report template.

PARAMETER	DESCRIPTION
report_template	The ReportTemplate or report template ID to use. TYPE: ReportTemplate | str
run	The Run or run ID to associate with the report. TYPE: Run | str
organization_id	The organization ID. TYPE: str | None DEFAULT: None
name	Optional name for the report. TYPE: str | None DEFAULT: None

RETURNS	DESCRIPTION
Job | None	The Job for the pending report, or None if no report was created.

create_from_rules async

create_from_rules(
    *,
    name: str,
    run: Run | str | None = None,
    organization_id: str | None = None,
    rules: list[Rule] | list[str],
    start_time: datetime | None = None,
    end_time: datetime | None = None,
) -> Job | None

Create a new report from rules.

PARAMETER	DESCRIPTION
name	The name of the report. TYPE: str
run	The run or run ID to associate with the report. TYPE: Run | str | None DEFAULT: None
organization_id	The organization ID. TYPE: str | None DEFAULT: None
rules	List of rules or rule IDs to include in the report. TYPE: list[Rule] | list[str]
start_time	Start of the time range to evaluate rules over. Ignored unless end_time is also set and a run is provided. TYPE: datetime | None DEFAULT: None
end_time	End of the time range to evaluate rules over. Ignored unless start_time is also set and a run is provided. TYPE: datetime | None DEFAULT: None

RETURNS	DESCRIPTION
Job | None	The Job for the pending report, or None if no report was created.

create_from_applicable_rules async

create_from_applicable_rules(
    *,
    run: Run | str | None = None,
    organization_id: str | None = None,
    name: str | None = None,
    start_time: datetime | None = None,
    end_time: datetime | None = None,
) -> Job | None

Create a new report from applicable rules based on a run. If you want to evaluate against assets, use the rules client instead since no report is created in that case.

PARAMETER	DESCRIPTION
run	The run or run ID to associate with the report. TYPE: Run | str | None DEFAULT: None
organization_id	The organization ID. TYPE: str | None DEFAULT: None
name	Optional name for the report. TYPE: str | None DEFAULT: None
start_time	Start of the time range to evaluate rules over. Ignored unless end_time is also set and a run is provided. TYPE: datetime | None DEFAULT: None
end_time	End of the time range to evaluate rules over. Ignored unless start_time is also set and a run is provided. TYPE: datetime | None DEFAULT: None

RETURNS	DESCRIPTION
Job | None	The Job for the pending report, or None if no report was created.

create_from_rule_versions async

create_from_rule_versions(
    *,
    name: str,
    run: Run | str | None = None,
    organization_id: str | None = None,
    rule_versions: list[RuleVersion] | list[str],
) -> Job | None

Create a new report from rule versions.

PARAMETER	DESCRIPTION
name	The name of the report. TYPE: str
run	The run or run ID to associate with the report. TYPE: Run | str | None DEFAULT: None
organization_id	The organization ID. TYPE: str | None DEFAULT: None
rule_versions	List of RuleVersions or rule_version IDs to include in the report. TYPE: list[RuleVersion] | list[str]

RETURNS	DESCRIPTION
Job | None	The Job for the pending report, or None if no report was created.

rerun async

rerun(*, report: str | Report) -> Job

Rerun a report.

PARAMETER	DESCRIPTION
report	The Report or report ID to rerun. TYPE: str | Report

RETURNS	DESCRIPTION
Job	The Job for the new pending report.

cancel async

cancel(*, report: str | Report) -> None

Cancel a report.

PARAMETER	DESCRIPTION
report	The Report or report ID to cancel. TYPE: str | Report

update async

update(
    report: str | Report, update: ReportUpdate | dict
) -> Report

Update a report.

PARAMETER	DESCRIPTION
report	The Report or report ID to update. TYPE: str | Report
update	The updates to apply. TYPE: ReportUpdate | dict

archive async

archive(*, report: str | Report) -> Report

Archive a report.

unarchive async

unarchive(*, report: str | Report) -> Report

Unarchive a report.

wait_until_complete async

wait_until_complete(
    *,
    report: Report | str | None = None,
    job: Job | str | None = None,
    polling_interval_secs: int = 5,
    timeout_secs: int | None = None,
) -> Report

Wait until the report is complete or the timeout is reached.

Polls the report job status at the given interval until the job is FINISHED, FAILED, or CANCELLED, returning the completed Report.

Either a report or job must be provided. The job must be a rule evaluation job.

PARAMETER	DESCRIPTION
report	The Report or report ID to wait for. TYPE: Report | str | None DEFAULT: None
job	The pending rule evaluation Job or job ID to wait for. TYPE: Job | str | None DEFAULT: None
polling_interval_secs	Seconds between status polls. Defaults to 5s. TYPE: int DEFAULT: 5
timeout_secs	Maximum seconds to wait. If None, polls indefinitely. Defaults to None (indefinite). TYPE: int | None DEFAULT: None

RETURNS	DESCRIPTION
Report	The Report in the completed state.

RAISES	DESCRIPTION
ValueError	If both or neither report and job are provided, or if job is not a rule evaluation job.

ReportTemplatesAPIAsync

ReportTemplatesAPIAsync(sift_client: SiftClient)

Bases: ResourceBase

High-level API for interacting with report templates.

Accessed as a nested resource of the Reports API via client.reports.templates.

Initialize the ReportTemplatesAPI.

PARAMETER	DESCRIPTION
sift_client	The Sift client to use. TYPE: SiftClient

METHOD	DESCRIPTION
get	Get a ReportTemplate.
list_	List report templates with optional filtering.
find	Find a single report template matching the given query. Takes the same arguments as list.
create	Create a new report template.
update	Update a report template.
archive	Archive a report template.
unarchive	Unarchive a report template.

ATTRIBUTE	DESCRIPTION
client	TYPE: SiftClient
grpc_client	TYPE: GrpcClient
rest_client	TYPE: RestClient

client property

client: SiftClient

grpc_client property

grpc_client: GrpcClient

rest_client property

rest_client: RestClient

get async

get(
    *,
    report_template_id: str | None = None,
    client_key: str | None = None,
    organization_id: str | None = None,
) -> ReportTemplate

Get a ReportTemplate.

PARAMETER	DESCRIPTION
report_template_id	The ID of the report template. TYPE: str | None DEFAULT: None
client_key	The client key of the report template. TYPE: str | None DEFAULT: None
organization_id	The organization ID. Only required when getting by client_key and the user belongs to multiple organizations. TYPE: str | None DEFAULT: None

RETURNS	DESCRIPTION
ReportTemplate	The ReportTemplate.

list_ async

list_(
    *,
    name: str | None = None,
    name_contains: str | None = None,
    name_regex: str | Pattern | None = None,
    names: list[str] | None = None,
    report_template_ids: list[str] | None = None,
    client_keys: list[str] | None = None,
    organization_id: str | None = None,
    metadata: dict[str, str | float | bool] | None = None,
    tag_names: list[str] | list[Tag] | None = None,
    include_archived: bool = False,
    filter_query: str | None = None,
    order_by: str | None = None,
    limit: int | None = None,
    page_size: int | None = None,
) -> list[ReportTemplate]

List report templates with optional filtering.

The report template service only supports filtering on the fields below; time and user based filters are not available for this resource.

PARAMETER	DESCRIPTION
name	Exact name of the report template. TYPE: str | None DEFAULT: None
name_contains	Partial name of the report template. TYPE: str | None DEFAULT: None
name_regex	Regular expression string to filter report templates by name. TYPE: str | Pattern | None DEFAULT: None
names	List of report template names to filter by. TYPE: list[str] | None DEFAULT: None
report_template_ids	List of report template IDs to filter by. TYPE: list[str] | None DEFAULT: None
client_keys	List of report template client keys to filter by. TYPE: list[str] | None DEFAULT: None
organization_id	Organization ID to filter by. TYPE: str | None DEFAULT: None
metadata	Metadata to filter by. TYPE: dict[str, str | float | bool] | None DEFAULT: None
tag_names	List of tags or tag names to filter by. TYPE: list[str] | list[Tag] | None DEFAULT: None
include_archived	Whether to include archived report templates. TYPE: bool DEFAULT: False
filter_query	Explicit CEL query to filter report templates. TYPE: str | None DEFAULT: None
order_by	How to order the retrieved report templates. TYPE: str | None DEFAULT: None
limit	How many report templates to retrieve. If None, retrieves all matches. TYPE: int | None DEFAULT: None
page_size	Number of results to fetch per request. Lower this if you hit gRPC message size limits on responses. If None, uses the server default. TYPE: int | None DEFAULT: None

RETURNS	DESCRIPTION
list[ReportTemplate]	A list of ReportTemplates that matches the filter.

find async

find(**kwargs) -> ReportTemplate | None

Find a single report template matching the given query. Takes the same arguments as list. If more than one report template is found, raises an error.

PARAMETER	DESCRIPTION
**kwargs	Keyword arguments to pass to list. DEFAULT: {}

RETURNS	DESCRIPTION
ReportTemplate | None	The ReportTemplate found or None.

create async

create(
    create: ReportTemplateCreate | dict,
) -> ReportTemplate

Create a new report template.

PARAMETER	DESCRIPTION
create	A ReportTemplateCreate object or a dictionary with configuration for the new report template. TYPE: ReportTemplateCreate | dict

RETURNS	DESCRIPTION
ReportTemplate	The created ReportTemplate.

update async

update(
    report_template: ReportTemplate | str,
    update: ReportTemplateUpdate | dict,
) -> ReportTemplate

Update a report template.

PARAMETER	DESCRIPTION
report_template	The ReportTemplate or report template ID to update. TYPE: ReportTemplate | str
update	The updates to apply. TYPE: ReportTemplateUpdate | dict

RETURNS	DESCRIPTION
ReportTemplate	The updated ReportTemplate.

archive async

archive(
    *, report_template: ReportTemplate | str
) -> ReportTemplate

Archive a report template.

unarchive async

unarchive(
    *, report_template: ReportTemplate | str
) -> ReportTemplate

Unarchive a report template.