Skip to main content

​
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.
MethodRequestResponseDescription
GetReportGetReportRequestGetReportResponseRetrieve a report.
CreateReportCreateReportRequestCreateReportResponseDeprecated - use RuleEvaluationService instead.
UpdateReportUpdateReportRequestUpdateReportResponseUpdate a report.
ListReportsListReportsRequestListReportsResponseList reports.
RerunReportRerunReportRequestRerunReportResponseRerunning 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.
CancelReportCancelReportRequestCancelReportResponseCanceling 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.
ListReportRuleSummariesListReportRuleSummariesRequestListReportRuleSummariesResponseList paginated rule summaries for a report.
ListReportMetadataValuesListReportMetadataValuesRequestListReportMetadataValuesResponseList paginated metadata values for a report.
ListReportsWithCumulativeSummaryListReportsWithCumulativeSummaryRequestListReportsWithCumulativeSummaryResponseList reports with cumulative summary.

​
Messages

Data models used across requests/responses.

​
CancelReportRequest

FieldTypeLabelDescription
report_idstring

​
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.
FieldTypeLabelDescription
report_template_idstring

​
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.
FieldTypeLabelDescription
namestring
descriptionstringoptional
tag_namesstringrepeated
oneof rule_identifiers. rule_idsCreateReportRequestRuleIds
oneof rule_identifiers. rule_client_keysCreateReportRequestClientKeys
oneof rule_identifiers. rule_version_idsCreateReportRequestRuleVersionIds

​
CreateReportRequest

Deprecated - use RuleEvaluationService instead.
FieldTypeLabelDescription
oneof request. report_from_report_template_requestCreateReportFromReportTemplateRequest
oneof request. report_from_rules_requestCreateReportFromRulesRequest
organization_idstring
run_idstring
namestringoptionalOverride the name of the report. If not provided, the name will be generated based on the report template or run.
metadatasift.metadata.v1.MetadataValuerepeated

​
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).
FieldTypeLabelDescription
rule_client_keysstringrepeated

​
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.
FieldTypeLabelDescription
rule_idsstringrepeated

​
CreateReportRequestRuleVersionIds

Deprecated - use RuleEvaluationService instead.
FieldTypeLabelDescription
rule_version_idsstringrepeated

​
CreateReportResponse

Deprecated - use RuleEvaluationService instead.
FieldTypeLabelDescription
reportReport

​
GetReportRequest

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

​
GetReportResponse

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

​
ListReportMetadataValuesRequest

The request for a call to ReportService_ListReportMetadataValues.
FieldTypeLabelDescription
report_idstringThe report whose metadata values to list.
page_sizeuint32The 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_tokenstringA page token, received from a previous ListReportMetadataValues call. Provide this to retrieve the subsequent page. Optional.
filterstringA 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.
FieldTypeLabelDescription
metadata_valuessift.metadata.v1.MetadataValuerepeated
next_page_tokenstring

​
ListReportRuleSummariesRequest

The request for a call to ReportService_ListReportRuleSummaries.
FieldTypeLabelDescription
report_idstringThe report whose rule summaries to list.
page_sizeuint32The 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_tokenstringA page token, received from a previous ListReportRuleSummaries call. Provide this to retrieve the subsequent page. Optional.
filterstringA 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_bystringHow 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.
FieldTypeLabelDescription
report_rule_summariesReportRuleSummaryrepeated
next_page_tokenstring

​
ListReportsRequest

The request for a call to ReportService_ListReports to retrieve report.
FieldTypeLabelDescription
page_sizeuint32The 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_tokenstringA 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.
filterstringA Common Expression Language (CEL) filter string. Available fields to filter by are report_id, report_template_id, tag_name, name, run_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. For more information about the fields used for filtering, please refer to this definition. Optional.
organization_idstringThis field is only required if your user belongs to multiple organizations.
order_bystringHow 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.
FieldTypeLabelDescription
reportsReportrepeated
next_page_tokenstring

​
ListReportsWithCumulativeSummaryRequest

The request for a call to ReportService_ListReportsWithCumulativeSummary to retrieve reports.
FieldTypeLabelDescription
page_sizeuint32The 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_tokenstringA 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.
filterstringA Common Expression Language (CEL) filter string. Available fields to filter by are report_id, report_template_id, tag_name, name, run_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. For more information about the fields used for filtering, please refer to this definition. Optional.
organization_idstringThis field is only required if your user belongs to multiple organizations.
order_bystringHow 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.
FieldTypeLabelDescription
reportsReportWithCumulativeSummaryrepeated
next_page_tokenstring

​
Report

FieldTypeLabelDescription
report_idstring
report_template_idstring
run_idstring
organization_idstring
namestring
descriptionstringoptional
created_by_user_idstring
modified_by_user_idstring
created_dategoogle.protobuf.Timestamp
modified_dategoogle.protobuf.Timestamp
summariesReportRuleSummaryrepeatedOne 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.
tagsReportTagrepeated
rerun_from_report_idstringoptional
job_idstringoptional
archived_dategoogle.protobuf.Timestampoptional
metadatasift.metadata.v1.MetadataValuerepeated
is_archivedbool

​
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.
FieldTypeLabelDescription
num_annotations_openuint32Total number of open (unresolved) annotations across all rules.
num_annotations_faileduint32Total number of failed (flagged) annotations across all rules.
num_annotations_passeduint32Total number of passed (resolved) annotations across all rules.
num_annotations_totaluint32Total number of annotations across all rules (open + failed + passed).
num_rules_createduint32Number of rule versions in CREATED status.
num_rules_liveuint32Number of rule versions currently running (LIVE status).
num_rules_finisheduint32Number of rule versions that finished successfully.
num_rules_faileduint32Number of rule versions that failed during execution.
num_rules_canceleduint32Number of rule versions that were canceled.
num_rules_erroruint32Number of rule versions that encountered an error.
num_rules_totaluint32Total number of rule versions across all statuses.
num_of_rules_without_annotationsuint32Number of finished rule versions that produced no annotations.

​
ReportRuleStatusDetails

FieldTypeLabelDescription
oneof details. createdReportRuleStatusDetailsCreated
oneof details. liveReportRuleStatusDetailsLive
oneof details. finishedReportRuleStatusDetailsFinished
oneof details. failedReportRuleStatusDetailsFailed
oneof details. canceledReportRuleStatusDetailsCanceled
oneof details. errorReportRuleStatusDetailsError

​
ReportRuleStatusDetailsCanceled

This message has no fields.

​
ReportRuleStatusDetailsCreated

This message has no fields.

​
ReportRuleStatusDetailsError

FieldTypeLabelDescription
error_messagestring
exit_codeint32optional
stdoutstringoptional
stderrstringoptional

​
ReportRuleStatusDetailsFailed

FieldTypeLabelDescription
error_messagestring
exit_codeint32optional
stdoutstringoptional
stderrstringoptional

​
ReportRuleStatusDetailsFinished

FieldTypeLabelDescription
stdoutstringoptional
stderrstringoptional

​
ReportRuleStatusDetailsLive

This message has no fields.

​
ReportRuleSummary

FieldTypeLabelDescription
rule_idstring
rule_client_keystring
rule_version_idstring
rule_version_numberuint32
report_rule_version_idstring
num_openuint32
num_faileduint32
num_passeduint32
statusReportRuleStatus
status_detailsReportRuleStatusDetails
created_dategoogle.protobuf.Timestamp
modified_dategoogle.protobuf.Timestamp
asset_idstring
deleted_dategoogle.protobuf.Timestamp
display_orderuint32Zero-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

FieldTypeLabelDescription
tag_namestring

​
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.
FieldTypeLabelDescription
report_idstringThe unique identifier of the report.
report_template_idstringThe identifier of the report template this report was created from, if any.
run_idstringThe identifier of the run associated with this report.
organization_idstringThe organization this report belongs to.
namestringThe display name of the report.
descriptionstringoptionalAn optional description of the report.
created_by_user_idstringThe identifier of the user who created the report.
modified_by_user_idstringThe identifier of the user who last modified the report.
created_dategoogle.protobuf.TimestampWhen the report was created.
modified_dategoogle.protobuf.TimestampWhen the report was last modified.
cumulative_summaryReportCumulativeRuleSummaryAggregated rule summary across all rules on this report.
tagsReportTagrepeatedTags associated with this report.
rerun_from_report_idstringoptionalThe identifier of the report this report was rerun from, if any.
job_idstringoptionalThe identifier of the job that produced this report, if any.
archived_dategoogle.protobuf.TimestampoptionalWhen the report was archived, if it has been archived.
is_archivedboolWhether the report has been archived.

​
RerunReportRequest

FieldTypeLabelDescription
report_idstring

​
RerunReportResponse

FieldTypeLabelDescription
job_idstring
report_idstring

​
UpdateReportRequest

FieldTypeLabelDescription
reportReportThe report to update.
update_maskgoogle.protobuf.FieldMaskThe list of fields to be updated. The fields available to be updated are archived_date, is_archived, and metadata.

​
UpdateReportResponse

no response fields This message has no fields.

​
Enums

Allowed constant values used in message fields.

​
ReportRuleStatus

NameNumberDescription
REPORT_RULE_STATUS_UNSPECIFIED0
REPORT_RULE_STATUS_CREATED1
REPORT_RULE_STATUS_LIVE2
REPORT_RULE_STATUS_FINISHED3
REPORT_RULE_STATUS_FAILED4
REPORT_RULE_STATUS_CANCELED5
REPORT_RULE_STATUS_ERROR6