reports - Sift

Services

RPC methods exposed by this API.

ReportService

Report access is gated on the parent run’s view_details (RESOURCE_TYPE_RUN), not on RESOURCE_TYPE_REPORT (which the policy evaluation service does not yet support). RPCs that have a run id directly on the request use inbound_policy_enforcement; RPCs that resolve the run via a DB lookup (e.g. report_id -> report -> run_id) use manual_policy_enforcement and do the check in the handler. See web-service/authorization/authorization.go for the helpers.

Method	Request	Response	Description
GetReport	GetReportRequest	GetReportResponse	Retrieve a report.
CreateReport	CreateReportRequest	CreateReportResponse	Deprecated - use RuleEvaluationService instead.
UpdateReport	UpdateReportRequest	UpdateReportResponse	Update a report.
ListReports	ListReportsRequest	ListReportsResponse	List reports.
RerunReport	RerunReportRequest	RerunReportResponse	Rerunning a report will create a new report with the same rule versions and run as the original report and run the evaluation again using the most up-to-date set of data.
CancelReport	CancelReportRequest	CancelReportResponse	Canceling a report will stop the evaluation of the report and mark it as canceled. Any results that have been calculated up to the point of cancellation will be saved.
ListReportRuleSummaries	ListReportRuleSummariesRequest	ListReportRuleSummariesResponse	List paginated rule summaries for a report.
ListReportMetadataValues	ListReportMetadataValuesRequest	ListReportMetadataValuesResponse	List paginated metadata values for a report.
ListReportsWithCumulativeSummary	ListReportsWithCumulativeSummaryRequest	ListReportsWithCumulativeSummaryResponse	List reports with cumulative summary.

Messages

Data models used across requests/responses.

CancelReportRequest

Field	Type	Label	Description
report_id	string

CancelReportResponse

no response fields This message has no fields.

CreateReportFromReportTemplateRequest

Deprecated - use RuleEvaluationService instead. Report rule lines use each template rule’s display_order from ReportTemplateRule at creation time.

Field	Type	Label	Description
report_template_id	string

CreateReportFromRulesRequest

Deprecated - use RuleEvaluationService instead. How rules are ordered on the created report depends on rule_identifiers: list order for rule_ids, or server resolution order for rule_client_keys.

Field	Type	Label
name	string
description	string	optional
tag_names	string	repeated
oneof rule_identifiers. rule_ids	CreateReportRequestRuleIds
oneof rule_identifiers. rule_client_keys	CreateReportRequestClientKeys
oneof rule_identifiers. rule_version_ids	CreateReportRequestRuleVersionIds

CreateReportRequest

Deprecated - use RuleEvaluationService instead.

Field	Type	Label	Description
oneof request. report_from_report_template_request	CreateReportFromReportTemplateRequest
oneof request. report_from_rules_request	CreateReportFromRulesRequest
organization_id	string
run_id	string
name	string	optional	Override the name of the report. If not provided, the name will be generated based on the report template or run.
metadata	sift.metadata.v1.MetadataValue	repeated

CreateReportRequestClientKeys

Deprecated - use RuleEvaluationService instead. Rule order on the created report follows the order in which the server resolves these keys to rules (not client-defined).

Field	Type	Label	Description
rule_client_keys	string	repeated

CreateReportRequestRuleIds

Deprecated - use RuleEvaluationService instead. The order of rule_ids is the report rule order: first ID is display_order 0, second is 1, etc., on the created report.

Field	Type	Label	Description
rule_ids	string	repeated

CreateReportRequestRuleVersionIds

Deprecated - use RuleEvaluationService instead.

Field	Type	Label	Description
rule_version_ids	string	repeated

CreateReportResponse

Deprecated - use RuleEvaluationService instead.

Field	Type	Label	Description
report	Report

GetReportRequest

The request for a call to ReportService_GetReport to retrieve a report template.

Field	Type	Label	Description
report_id	string

GetReportResponse

The request of a call to ReportService_GetReport to retrieve a report template.

Field	Type	Label	Description
report	Report

ListReportMetadataValuesRequest

The request for a call to ReportService_ListReportMetadataValues.

Field	Type	Description
report_id	string	The report whose metadata values to list.
page_size	uint32	The maximum number of metadata values to return. The service may return fewer than this value. If unspecified, at most 50 metadata values will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.
page_token	string	A page token, received from a previous `ListReportMetadataValues` call. Provide this to retrieve the subsequent page. Optional.
filter	string	A Common Expression Language (CEL) filter string. Available fields to filter by are `key_name`, `value_string`, `value_number`, `value_boolean`, `key_is_archived`, and `value_is_archived`. Optional.

ListReportMetadataValuesResponse

The response of a call to ReportService_ListReportMetadataValues.

Field	Type	Label	Description
metadata_values	sift.metadata.v1.MetadataValue	repeated
next_page_token	string

ListReportRuleSummariesRequest

The request for a call to ReportService_ListReportRuleSummaries.

Field	Type	Description
report_id	string	The report whose rule summaries to list.
page_size	uint32	The maximum number of rule summaries to return. The service may return fewer than this value. If unspecified, at most 50 rule summaries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.
page_token	string	A page token, received from a previous `ListReportRuleSummaries` call. Provide this to retrieve the subsequent page. Optional.
filter	string	A Common Expression Language (CEL) filter string. Available fields to filter by are `rule_id`, `rule_version_id`, `asset_id`, `status`, `created_date`, and `modified_date`. Optional.
order_by	string	How to order the retrieved rule summaries. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order by are `display_order`, `created_date`, and `modified_date`. If left empty, items are ordered by `display_order` ascending.

ListReportRuleSummariesResponse

The response of a call to ReportService_ListReportRuleSummaries.

Field	Type	Label	Description
report_rule_summaries	ReportRuleSummary	repeated
next_page_token	string

ListReportsRequest

The request for a call to ReportService_ListReports to retrieve report.

Field	Type	Description
page_size	uint32	The maximum number of reports to return. The service may return fewer than this value. If unspecified, at most 50 reports will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.
page_token	string	A page token, received from a previous `ListReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReports` must match the call that provided the page token. Optional.
filter	string	A Common Expression Language (CEL) filter string. Available fields to filter by are `report_id`, `report_template_id`, `tag_name`, `name`, `run_id`, `report_type`, `canvas_id`, `is_archived`, `archived_date`, `created_date`, `created_by_user_id`, `metadata`, `modified_date`, and `modified_by_user_id`. For further information about how to use CELs, please refer to this guide.
organization_id	string	This field is only required if your user belongs to multiple organizations.
order_by	string	How to order the retrieved reports. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are `name`, `created_date` and `modified_date`. If left empty, items are ordered by `created_date` in descending order (newest-first). For more information about the format of this field, read this Example: “created_date desc,modified_date”

ListReportsResponse

The response of a call to ReportService_ListReportsResponse.

Field	Type	Label	Description
reports	Report	repeated
next_page_token	string

ListReportsWithCumulativeSummaryRequest

The request for a call to ReportService_ListReportsWithCumulativeSummary to retrieve reports.

Field	Type	Description
page_size	uint32	The maximum number of reports to return. The service may return fewer than this value. If unspecified, at most 50 reports will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.
page_token	string	A page token, received from a previous `ListReportsWithCumulativeSummary` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReportsWithCumulativeSummary` must match the call that provided the page token. Optional.
filter	string	A Common Expression Language (CEL) filter string. Available fields to filter by are `report_id`, `report_template_id`, `tag_name`, `name`, `run_id`, `report_type`, `canvas_id`, `is_archived`, `archived_date`, `created_date`, `created_by_user_id`, `metadata`, `modified_date`, and `modified_by_user_id`. For further information about how to use CELs, please refer to this guide.
organization_id	string	This field is only required if your user belongs to multiple organizations.
order_by	string	How to order the retrieved reports. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are `name`, `created_date` and `modified_date`. If left empty, items are ordered by `created_date` in descending order (newest-first). For more information about the format of this field, read this Example: “created_date desc,modified_date”

ListReportsWithCumulativeSummaryResponse

The response of a call to ReportService_ListReportsWithCumulativeSummaryResponse.

Field	Type	Label	Description
reports	ReportWithCumulativeSummary	repeated
next_page_token	string

Report

Field	Type	Label	Description
report_id	string
report_template_id	string
run_id	string		Populated for RULE_EVALUATION reports (which are tied to a run). Empty string for CANVAS reports. Kept REQUIRED (rather than a wrapped optional) to mirror ReportWithCumulativeSummary and avoid rippling optionality through existing rule-report clients.
organization_id	string
name	string
description	string	optional
created_by_user_id	string
modified_by_user_id	string
created_date	google.protobuf.Timestamp
modified_date	google.protobuf.Timestamp
summaries	ReportRuleSummary	repeated	One entry per rule line on this report. Sort by `display_order` ascending for the canonical evaluation / display sequence (clients may still group by status for UI). `display_order` is set when the report is created from a template or from rules.
tags	ReportTag	repeated
rerun_from_report_id	string	optional
job_id	string	optional
archived_date	google.protobuf.Timestamp	optional
metadata	sift.metadata.v1.MetadataValue	repeated
is_archived	bool
report_type	ReportType		Discriminates the report kind. Defaults to RULE_EVALUATION for existing rows.
canvas_execution_id	string	optional	For CANVAS reports, the id of the published canvas_execution this report row is linked to (read-through from canvas_executions.canvas_execution_id). Empty for RULE_EVALUATION reports. Used by clients to route to the canvas detail page.
canvas_status	sift.canvas.v1.CanvasCellExecutionStatus	optional	For CANVAS reports, the execution status read through from the linked canvas_executions.status. Unset for RULE_EVALUATION reports (whose status is conveyed via the per-rule `summaries` instead).
canvas_version_id	string	optional	For CANVAS reports, the id of the canvas_version the linked execution was run from (read-through from canvas_executions.canvas_version_id). Empty for RULE_EVALUATION reports. Used by clients to route to the canvas source and to re-run the report from the same version.
canvas_id	string	optional	For CANVAS reports, the id of the canvas the linked execution was published from (resolved through canvas_versions.canvas_id). Empty for RULE_EVALUATION reports, whose equivalent grouping is `report_template_id`. Also the value matched by the `canvas_id` list filter. Resolve the canvas’s display name by listing canvases filtered on the ids collected from a page of reports.
is_automated	bool	optional	For CANVAS reports, whether the linked execution was produced by an automation trigger (read-through from canvas_executions.automation_trigger_id being set). Unset for RULE_EVALUATION reports. Display only; there is no matching list filter.

ReportCumulativeRuleSummary

Aggregated annotation and rule-status counts across all rules in a report. Annotation counts (num_annotations_) reflect the total number of annotations in each state summed over every rule version in the report. Rule counts (num_rules_) reflect how many rule versions are in each execution status.

Field	Type	Description
num_annotations_open	uint32	Total number of open (unresolved) annotations across all rules.
num_annotations_failed	uint32	Total number of failed (flagged) annotations across all rules.
num_annotations_passed	uint32	Total number of passed (resolved) annotations across all rules.
num_annotations_total	uint32	Total number of annotations across all rules (open + failed + passed).
num_rules_created	uint32	Number of rule versions in CREATED status.
num_rules_live	uint32	Number of rule versions currently running (LIVE status).
num_rules_finished	uint32	Number of rule versions that finished successfully.
num_rules_failed	uint32	Number of rule versions that failed during execution.
num_rules_canceled	uint32	Number of rule versions that were canceled.
num_rules_error	uint32	Number of rule versions that encountered an error.
num_rules_total	uint32	Total number of rule versions across all statuses.
num_of_rules_without_annotations	uint32	Number of finished rule versions that produced no annotations.

ReportRuleStatusDetails

Field	Type	Label	Description
oneof details. created	ReportRuleStatusDetailsCreated
oneof details. live	ReportRuleStatusDetailsLive
oneof details. finished	ReportRuleStatusDetailsFinished
oneof details. failed	ReportRuleStatusDetailsFailed
oneof details. canceled	ReportRuleStatusDetailsCanceled
oneof details. error	ReportRuleStatusDetailsError

ReportRuleStatusDetailsCanceled

This message has no fields.

ReportRuleStatusDetailsCreated

This message has no fields.

ReportRuleStatusDetailsError

Field	Type	Label
error_message	string
exit_code	int32	optional
stdout	string	optional
stderr	string	optional

ReportRuleStatusDetailsFailed

Field	Type	Label
error_message	string
exit_code	int32	optional
stdout	string	optional
stderr	string	optional

ReportRuleStatusDetailsFinished

Field	Type	Label	Description
stdout	string	optional
stderr	string	optional

ReportRuleStatusDetailsLive

This message has no fields.

ReportRuleSummary

Field	Type	Label	Description
rule_id	string
rule_client_key	string
rule_version_id	string
rule_version_number	uint32
report_rule_version_id	string
num_open	uint32
num_failed	uint32
num_passed	uint32
status	ReportRuleStatus
status_details	ReportRuleStatusDetails
created_date	google.protobuf.Timestamp
modified_date	google.protobuf.Timestamp
asset_id	string
deleted_date	google.protobuf.Timestamp
resolved_family_stats	ResolvedFamilyStat	repeated
resolved_alignment_configs	ResolvedAlignmentEntry	repeated
display_order	uint32		Zero-based position of this rule line on the report. Copied from the report template rule’s `display_order`, or from the position of `rule_id` in `CreateReportRequestRuleIds.rule_ids` when creating from explicit rule IDs. Lower values run first.

ReportTag

Field	Type	Label	Description
tag_name	string

ReportWithCumulativeSummary

ReportWithCumulativeSummary is a projection of Report that replaces the per-rule summaries list with a single cumulative_summary aggregated across all rules. It is returned by ListReportsWithCumulativeSummary to keep response sizes manageable when listing many reports.

Field	Type	Label	Description
report_id	string		The unique identifier of the report.
report_template_id	string		The identifier of the report template this report was created from, if any.
run_id	string		The identifier of the run associated with this report.
organization_id	string		The organization this report belongs to.
name	string		The display name of the report.
description	string	optional	An optional description of the report.
created_by_user_id	string		The identifier of the user who created the report.
modified_by_user_id	string		The identifier of the user who last modified the report.
created_date	google.protobuf.Timestamp		When the report was created.
modified_date	google.protobuf.Timestamp		When the report was last modified.
cumulative_summary	ReportCumulativeRuleSummary		Aggregated rule summary across all rules on this report.
tags	ReportTag	repeated	Tags associated with this report.
rerun_from_report_id	string	optional	The identifier of the report this report was rerun from, if any.
job_id	string	optional	The identifier of the job that produced this report, if any.
archived_date	google.protobuf.Timestamp	optional	When the report was archived, if it has been archived.
is_archived	bool		Whether the report has been archived.
report_type	ReportType		Discriminates the report kind. Defaults to RULE_EVALUATION for existing rows.
canvas_execution_id	string	optional	For CANVAS reports, the id of the published canvas_execution this report row is linked to (read-through from canvas_executions.canvas_execution_id). Empty for RULE_EVALUATION reports. Used by clients to route to the canvas detail page.
canvas_status	sift.canvas.v1.CanvasCellExecutionStatus	optional	For CANVAS reports, the execution status read through from the linked canvas_executions.status. Unset for RULE_EVALUATION reports (whose status is conveyed via the `cumulative_summary` instead).
canvas_version_id	string	optional	For CANVAS reports, the id of the canvas_version the linked execution was run from (read-through from canvas_executions.canvas_version_id). Empty for RULE_EVALUATION reports. Used by clients to route to the canvas source and to re-run the report from the same version.
canvas_id	string	optional	For CANVAS reports, the id of the canvas the linked execution was published from (resolved through canvas_versions.canvas_id). Empty for RULE_EVALUATION reports, whose equivalent grouping is `report_template_id`. Also the value matched by the `canvas_id` list filter. Resolve the canvas’s display name by listing canvases filtered on the ids collected from a page of reports.
is_automated	bool	optional	For CANVAS reports, whether the linked execution was produced by an automation trigger (read-through from canvas_executions.automation_trigger_id being set). Unset for RULE_EVALUATION reports. Display only; there is no matching list filter.

RerunReportRequest

Field	Type	Label	Description
report_id	string

RerunReportResponse

Field	Type	Label	Description
job_id	string
report_id	string

ResolvedAlignmentEntry

Field	Type	Label
channel_references	string	repeated
t0	ResolvedAlignmentPoint
start_time	ResolvedAlignmentPoint
end_time	ResolvedAlignmentPoint

ResolvedAlignmentPoint

Field	Type	Label	Description
timestamp	google.protobuf.Timestamp
oneof alignment_config. run	sift.families.v1.RunAlignment
oneof alignment_config. annotation	sift.families.v1.AnnotationAlignment
oneof alignment_config. timestamp_config	sift.families.v1.TimestampAlignment

ResolvedFamilyStat

Field	Type	Label	Description
reference	string
family_id	string
family_version_id	string
family_stat_expression_id	string
family_stat_range_id	string

UpdateReportRequest

Field	Type	Label	Description
report	Report		The report to update.
update_mask	google.protobuf.FieldMask		The list of fields to be updated. The fields available to be updated are `name`, `description`, `archived_date`, `is_archived`, and `metadata`. An empty `name` is ignored and the existing name is preserved. Including `description` in the mask with the field unset clears the description.

UpdateReportResponse

no response fields This message has no fields.

Enums

Allowed constant values used in message fields.

ReportRuleStatus

Name	Number	Description
REPORT_RULE_STATUS_UNSPECIFIED	0
REPORT_RULE_STATUS_CREATED	1
REPORT_RULE_STATUS_LIVE	2
REPORT_RULE_STATUS_FINISHED	3
REPORT_RULE_STATUS_FAILED	4
REPORT_RULE_STATUS_CANCELED	5
REPORT_RULE_STATUS_ERROR	6

ReportType

ReportType discriminates the two kinds of report rows that share the unified reports surface. Rule-evaluation reports are tied to a run; canvas reports are tied to a published canvas_execution.

Name	Number	Description
REPORT_TYPE_UNSPECIFIED	0
REPORT_TYPE_RULE_EVALUATION	1
REPORT_TYPE_CANVAS	2

​Services

​ReportService

​Messages

​CancelReportRequest

​CancelReportResponse

​CreateReportFromReportTemplateRequest

​CreateReportFromRulesRequest

​CreateReportRequest

​CreateReportRequestClientKeys

​CreateReportRequestRuleIds

​CreateReportRequestRuleVersionIds

​CreateReportResponse

​GetReportRequest

​GetReportResponse

​ListReportMetadataValuesRequest

​ListReportMetadataValuesResponse

​ListReportRuleSummariesRequest

​ListReportRuleSummariesResponse

​ListReportsRequest

​ListReportsResponse

​ListReportsWithCumulativeSummaryRequest

​ListReportsWithCumulativeSummaryResponse

​Report

​ReportCumulativeRuleSummary

​ReportRuleStatusDetails

​ReportRuleStatusDetailsCanceled

​ReportRuleStatusDetailsCreated

​ReportRuleStatusDetailsError

​ReportRuleStatusDetailsFailed

​ReportRuleStatusDetailsFinished

​ReportRuleStatusDetailsLive

​ReportRuleSummary

​ReportTag

​ReportWithCumulativeSummary

​RerunReportRequest

​RerunReportResponse

​ResolvedAlignmentEntry

​ResolvedAlignmentPoint

​ResolvedFamilyStat

​UpdateReportRequest

​UpdateReportResponse

​Enums

​ReportRuleStatus

​ReportType

Services

ReportService

Messages

CancelReportRequest

CancelReportResponse

CreateReportFromReportTemplateRequest

CreateReportFromRulesRequest

CreateReportRequest

CreateReportRequestClientKeys

CreateReportRequestRuleIds

CreateReportRequestRuleVersionIds

CreateReportResponse

GetReportRequest

GetReportResponse

ListReportMetadataValuesRequest

ListReportMetadataValuesResponse

ListReportRuleSummariesRequest

ListReportRuleSummariesResponse

ListReportsRequest

ListReportsResponse

ListReportsWithCumulativeSummaryRequest

ListReportsWithCumulativeSummaryResponse

Report

ReportCumulativeRuleSummary

ReportRuleStatusDetails

ReportRuleStatusDetailsCanceled

ReportRuleStatusDetailsCreated

ReportRuleStatusDetailsError

ReportRuleStatusDetailsFailed

ReportRuleStatusDetailsFinished

ReportRuleStatusDetailsLive

ReportRuleSummary

ReportTag

ReportWithCumulativeSummary

RerunReportRequest

RerunReportResponse

ResolvedAlignmentEntry

ResolvedAlignmentPoint

ResolvedFamilyStat

UpdateReportRequest

UpdateReportResponse

Enums

ReportRuleStatus

ReportType